Class I2CPortMap

Different from Web I2C API specification.

Hierarchy

Map<PortNumber, I2CPort>
- I2CPortMap

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new I2CPortMap(entries?: null | readonly readonly [number, I2CPort][]): I2CPortMap
new I2CPortMap(iterable: Iterable<readonly [number, I2CPort]>): I2CPortMap

Inherited from Map<PortNumber, I2CPort>.constructor
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:33
Parameters
- Optional entries: null | readonly readonly [number, I2CPort][]
Returns I2CPortMap
Inherited from Map<PortNumber, I2CPort>.constructor
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:160
Parameters
- iterable: Iterable<readonly [number, I2CPort]>
Returns I2CPortMap

Properties

Readonly [toStringTag]

[toStringTag]: string

Readonly size

size: number

Static Readonly [species]

[species]: MapConstructor

Methods

[iterator]

[iterator](): IterableIterator<[number, I2CPort]>

Inherited from Map.__@iterator@83
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:121
Returns an iterable of entries in the map.

Returns IterableIterator<[number, I2CPort]>

clear

clear(): void

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

delete

delete(key: number): boolean

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

entries

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

Inherited from Map.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<[number, I2CPort]>

forEach

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

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

get

get(key: number): undefined | I2CPort

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

getByName

getByName(portName: string): undefined | I2CPort

- Defined in index.ts:58
Parameters
- portName: string
Returns undefined | I2CPort

has

has(key: number): boolean

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

keys

keys(): IterableIterator<number>

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

Returns IterableIterator<number>

set

set(key: number, value: I2CPort): I2CPortMap

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

values

values(): IterableIterator<I2CPort>

Inherited from Map.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