ClassSerialBinding`Internal`

For documentation purposes only. Use singleton instance exported as serial

Hierarchy

TypedEmitter<SerialBindingEvents>
- SerialBinding

Index

Constructors

constructor

new SerialBinding(): SerialBinding
Returns SerialBinding
Inherited from TypedEmitter<SerialBindingEvents>.constructor

Properties

`Static`defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener<U>(event, listener): this
Type Parameters
- U extends keyof SerialBindingEvents
Parameters
- event: U
- listener: SerialBindingEvents[U]
Returns this
Inherited from TypedEmitter.addListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:11

close

close(path): boolean
Close serial session
Parameters
- path: string
Returns boolean
- Defined in packages/serial/src/serial.ts:160

emit

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

eventNames

eventNames<U>(): U[]
Type Parameters
- U extends keyof SerialBindingEvents
Returns U[]
Inherited from TypedEmitter.eventNames
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:20

getMaxListeners

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

getSessions

getSessions(): SerialSession[]
Get all serial sessions

Returns SerialSession[]
- Defined in packages/serial/src/serial.ts:176

listenerCount

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

listeners

listeners<U>(type): SerialBindingEvents[U][]
Type Parameters
- U extends keyof SerialBindingEvents
Parameters
- type: U
Returns SerialBindingEvents[U][]
Inherited from TypedEmitter.listeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:22

off

off<U>(event, listener): this
Type Parameters
- U extends keyof SerialBindingEvents
Parameters
- event: U
- listener: SerialBindingEvents[U]
Returns this
Inherited from TypedEmitter.off
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:18

on

on<U>(event, listener): this
Type Parameters
- U extends keyof SerialBindingEvents
Parameters
- event: U
- listener: SerialBindingEvents[U]
Returns this
Inherited from TypedEmitter.on
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:17

once

once<U>(event, listener): this
Type Parameters
- U extends keyof SerialBindingEvents
Parameters
- event: U
- listener: SerialBindingEvents[U]
Returns this
Inherited from TypedEmitter.once
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:16

open

open(opts): Promise<SerialSession>
Connect to a serial device and open a serial session
Parameters
- opts: OpenOptions
Returns Promise<SerialSession>
- Defined in packages/serial/src/serial.ts:130

prependListener

prependListener<U>(event, listener): this
Type Parameters
- U extends keyof SerialBindingEvents
Parameters
- event: U
- listener: SerialBindingEvents[U]
Returns this
Inherited from TypedEmitter.prependListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:12

prependOnceListener

prependOnceListener<U>(event, listener): this
Type Parameters
- U extends keyof SerialBindingEvents
Parameters
- event: U
- listener: SerialBindingEvents[U]
Returns this
Inherited from TypedEmitter.prependOnceListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:13

rawListeners

rawListeners<U>(type): SerialBindingEvents[U][]
Type Parameters
- U extends keyof SerialBindingEvents
Parameters
- type: U
Returns SerialBindingEvents[U][]
Inherited from TypedEmitter.rawListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:23

release

release(): void
Close all serial sessions

Returns void
- Defined in packages/serial/src/serial.ts:183

removeAllListeners

removeAllListeners(event?): this
Parameters
- Optionalevent: keyof SerialBindingEvents
Returns this
Inherited from TypedEmitter.removeAllListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:15

removeListener

removeListener<U>(event, listener): this
Type Parameters
- U extends keyof SerialBindingEvents
Parameters
- event: U
- listener: SerialBindingEvents[U]
Returns this
Inherited from TypedEmitter.removeListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:14

setMaxListeners

setMaxListeners(n): this
Parameters
- n: number
Returns this
Inherited from TypedEmitter.setMaxListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:25