Class I2CPortMap

Different from Web I2C API specification.

Hierarchy

Map<PortNumber, I2CPort>
- I2CPortMap

Index

Properties

Methods

Properties

[Symbol.toStringTag]

[Symbol.toStringTag]: string

size

size: number

Static Map

Map: MapConstructor

Methods

[Symbol.iterator]

[Symbol.iterator](): IterableIterator<[PortNumber, I2CPort]>

Inherited from I2CPortMap.[Symbol.iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:121
Returns an iterable of entries in the map.

Returns IterableIterator<[PortNumber, I2CPort]>

clear

clear(): void

Inherited from I2CPortMap.clear
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:22
Returns void

delete

delete(key: PortNumber): boolean

Inherited from I2CPortMap.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:23
Parameters
- key: PortNumber
Returns boolean

entries

entries(): IterableIterator<[PortNumber, I2CPort]>

Inherited from I2CPortMap.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:126
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[PortNumber, I2CPort]>

forEach

forEach(callbackfn: (value: I2CPort, key: PortNumber, map: Map<PortNumber, I2CPort>) => void, thisArg?: any): void

Inherited from I2CPortMap.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:24
Parameters
- callbackfn: (value: I2CPort, key: PortNumber, map: Map<PortNumber, I2CPort>) => void
  - - (value: I2CPort, key: PortNumber, map: Map<PortNumber, I2CPort>): void
    - Parameters
      - value: I2CPort
      - key: PortNumber
      - map: Map<PortNumber, I2CPort>
      Returns void
- Optional thisArg: any
Returns void

get

get(key: PortNumber): I2CPort | undefined

Inherited from I2CPortMap.get
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:25
Parameters
- key: PortNumber
Returns I2CPort | undefined

getByName

getByName(portName: PortName): undefined | I2CPort

- Defined in node_modules/node-web-i2c/index.ts:32
Parameters
- portName: PortName
Returns undefined | I2CPort

has

has(key: PortNumber): boolean

Inherited from I2CPortMap.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:26
Parameters
- key: PortNumber
Returns boolean

keys

keys(): IterableIterator<PortNumber>

Inherited from I2CPortMap.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:131
Returns an iterable of keys in the map

Returns IterableIterator<PortNumber>

set

set(key: PortNumber, value: I2CPort): this

Inherited from I2CPortMap.set
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:27
Parameters
- key: PortNumber
- value: I2CPort
Returns this

values

values(): IterableIterator<I2CPort>

Inherited from I2CPortMap.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:136
Returns an iterable of values in the map

Returns IterableIterator<I2CPort>

Generated using TypeDoc