Class SerialBinding

internal: For documentation purposes only. Use singleton instance exported as default

Hierarchy

TypedEmitter<SerialBindingEvents>
- SerialBinding

Index

Constructors

constructor

new SerialBinding(): SerialBinding

Inherited from TypedEmitter<SerialBindingEvents>.constructor
Returns SerialBinding

Properties

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener<U>(event: U, listener: SerialBindingEvents[U]): SerialBinding

Inherited from TypedEmitter.addListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:11
Type parameters
- U: keyof SerialBindingEvents
Parameters
- event: U
- listener: SerialBindingEvents[U]
Returns SerialBinding

close

close(path: string): boolean

- Defined in packages/serial/src/serial.ts:160
Close serial session

Parameters
- path: string
Returns boolean

emit

emit<U>(event: U, ...args: Parameters<SerialBindingEvents[U]>): boolean

Inherited from TypedEmitter.emit
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:19
Type parameters
- U: keyof SerialBindingEvents
Parameters
- event: U
- Rest ...args: Parameters<SerialBindingEvents[U]>
Returns boolean

eventNames

eventNames<U>(): U[]

Inherited from TypedEmitter.eventNames
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:20
Type parameters
- U: keyof SerialBindingEvents
Returns U[]

getMaxListeners

getMaxListeners(): number

Inherited from TypedEmitter.getMaxListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:24
Returns number

getSessions

getSessions(): SerialSession[]

- Defined in packages/serial/src/serial.ts:176
Get all serial sessions

Returns SerialSession[]

listenerCount

listenerCount(type: keyof SerialBindingEvents): number

Inherited from TypedEmitter.listenerCount
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:21
Parameters
- type: keyof SerialBindingEvents
Returns number

listeners

listeners<U>(type: U): SerialBindingEvents[U][]

Inherited from TypedEmitter.listeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:22
Type parameters
- U: keyof SerialBindingEvents
Parameters
- type: U
Returns SerialBindingEvents[U][]

off

off<U>(event: U, listener: SerialBindingEvents[U]): SerialBinding

Inherited from TypedEmitter.off
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:18
Type parameters
- U: keyof SerialBindingEvents
Parameters
- event: U
- listener: SerialBindingEvents[U]
Returns SerialBinding

on

on<U>(event: U, listener: SerialBindingEvents[U]): SerialBinding

Inherited from TypedEmitter.on
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:17
Type parameters
- U: keyof SerialBindingEvents
Parameters
- event: U
- listener: SerialBindingEvents[U]
Returns SerialBinding

once

once<U>(event: U, listener: SerialBindingEvents[U]): SerialBinding

Inherited from TypedEmitter.once
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:16
Type parameters
- U: keyof SerialBindingEvents
Parameters
- event: U
- listener: SerialBindingEvents[U]
Returns SerialBinding

open

open(opts: OpenOptions): Promise<SerialSession>

- Defined in packages/serial/src/serial.ts:130
Connect to a serial device and open a serial session

Parameters
- opts: OpenOptions
Returns Promise<SerialSession>

prependListener

prependListener<U>(event: U, listener: SerialBindingEvents[U]): SerialBinding

Inherited from TypedEmitter.prependListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:12
Type parameters
- U: keyof SerialBindingEvents
Parameters
- event: U
- listener: SerialBindingEvents[U]
Returns SerialBinding

prependOnceListener

prependOnceListener<U>(event: U, listener: SerialBindingEvents[U]): SerialBinding

Inherited from TypedEmitter.prependOnceListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:13
Type parameters
- U: keyof SerialBindingEvents
Parameters
- event: U
- listener: SerialBindingEvents[U]
Returns SerialBinding

rawListeners

rawListeners<U>(type: U): SerialBindingEvents[U][]

Inherited from TypedEmitter.rawListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:23
Type parameters
- U: keyof SerialBindingEvents
Parameters
- type: U
Returns SerialBindingEvents[U][]

release

release(): void

- Defined in packages/serial/src/serial.ts:183
Close all serial sessions

Returns void

removeAllListeners

removeAllListeners(event?: keyof SerialBindingEvents): SerialBinding

Inherited from TypedEmitter.removeAllListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:15
Parameters
- Optional event: keyof SerialBindingEvents
Returns SerialBinding

removeListener

removeListener<U>(event: U, listener: SerialBindingEvents[U]): SerialBinding

Inherited from TypedEmitter.removeListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:14
Type parameters
- U: keyof SerialBindingEvents
Parameters
- event: U
- listener: SerialBindingEvents[U]
Returns SerialBinding

setMaxListeners

setMaxListeners(n: number): SerialBinding

Inherited from TypedEmitter.setMaxListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:25
Parameters
- n: number
Returns SerialBinding

Generated using TypeDoc