Class NetBinding

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

Hierarchy

TypedEmitter<NetBindingEvents>
- NetBinding

Index

Constructors

constructor

Properties

defaultMaxListeners

Accessors

sessions

Methods

Constructors

constructor

new NetBinding(): NetBinding

Inherited from TypedEmitter<NetBindingEvents>.constructor
Returns NetBinding

Properties

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

sessions

get sessions(): Readonly<Record<string, NetSession>>

- Defined in packages/net/src/net.ts:103
Get all network sessions

Returns Readonly<Record<string, NetSession>>

Methods

addListener

addListener<U>(event: U, listener: NetBindingEvents[U]): NetBinding

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

close

close(address: string): boolean

- Defined in packages/net/src/net.ts:151
Close network session

Parameters
- address: string
  
  host(:port)?
Returns boolean
false if no connection is found

emit

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

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

getMaxListeners

getMaxListeners(): number

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

listenerCount

listenerCount(type: keyof NetBindingEvents): number

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

listeners

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

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

off

off<U>(event: U, listener: NetBindingEvents[U]): NetBinding

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

on

on<U>(event: U, listener: NetBindingEvents[U]): NetBinding

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

once

once<U>(event: U, listener: NetBindingEvents[U]): NetBinding

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

open

open(address: string): NetSession

- Defined in packages/net/src/net.ts:111
Connect to network device and open a new session

Parameters
- address: string
  
  host(:port)?
Returns NetSession

prependListener

prependListener<U>(event: U, listener: NetBindingEvents[U]): NetBinding

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

prependOnceListener

prependOnceListener<U>(event: U, listener: NetBindingEvents[U]): NetBinding

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

rawListeners

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

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

release

release(): void

- Defined in packages/net/src/net.ts:167
Close all network sessions

Returns void

removeAllListeners

removeAllListeners(event?: keyof NetBindingEvents): NetBinding

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

removeListener

removeListener<U>(event: U, listener: NetBindingEvents[U]): NetBinding

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

setMaxListeners

setMaxListeners(n: number): NetBinding

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

Generated using TypeDoc