ClassNetBinding`Internal`

For documentation purposes only. Use singleton instance exported as net

Hierarchy

TypedEmitter<NetBindingEvents>
- NetBinding

Index

Constructors

Properties

defaultMaxListeners

Accessors

Methods

addListener close emit eventNames getMaxListeners listenerCount listeners off on once open prependListener prependOnceListener rawListeners release removeAllListeners removeListener setMaxListeners

Constructors

constructor

new NetBinding(): NetBinding
Returns NetBinding
Inherited from TypedEmitter<NetBindingEvents>.constructor

Properties

`Static`defaultMaxListeners

defaultMaxListeners: number

Accessors

sessions

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

Returns Readonly<Record<string, NetSession>>
- Defined in packages/net/src/net.ts:104

Methods

addListener

addListener<U>(event, listener): this
Type Parameters
- U extends keyof NetBindingEvents
Parameters
- event: U
- listener: NetBindingEvents[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(address): boolean
Close network session
Parameters
- address: string
  host(:port)?
Returns boolean
false if no connection is found
- Defined in packages/net/src/net.ts:158

emit

emit<U>(event, ...args): boolean
Type Parameters
- U extends keyof NetBindingEvents
Parameters
- event: U
- Rest...args: Parameters<NetBindingEvents[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 NetBindingEvents
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

listenerCount

listenerCount(type): number
Parameters
- type: keyof NetBindingEvents
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): NetBindingEvents[U][]
Type Parameters
- U extends keyof NetBindingEvents
Parameters
- type: U
Returns NetBindingEvents[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 NetBindingEvents
Parameters
- event: U
- listener: NetBindingEvents[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 NetBindingEvents
Parameters
- event: U
- listener: NetBindingEvents[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 NetBindingEvents
Parameters
- event: U
- listener: NetBindingEvents[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(address): NetSession
Connect to network device and open a new session
Parameters
- address: string
  host(:port)?
Returns NetSession
- Defined in packages/net/src/net.ts:112

prependListener

prependListener<U>(event, listener): this
Type Parameters
- U extends keyof NetBindingEvents
Parameters
- event: U
- listener: NetBindingEvents[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 NetBindingEvents
Parameters
- event: U
- listener: NetBindingEvents[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): NetBindingEvents[U][]
Type Parameters
- U extends keyof NetBindingEvents
Parameters
- type: U
Returns NetBindingEvents[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 network sessions

Returns void
- Defined in packages/net/src/net.ts:174

removeAllListeners

removeAllListeners(event?): this
Parameters
- Optionalevent: keyof NetBindingEvents
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 NetBindingEvents
Parameters
- event: U
- listener: NetBindingEvents[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