Interface Client

A Junknet client. It's responsible for finishing some jobs by distributing them among daemons it knows about.

experimental

Hierarchy

TypedEmitter<ClientEvents>
- Client

Implemented by

GenericClient

Index

Methods

Methods

addListener

addListener<E>(event: E, listener: ClientEvents[E]): Client

- Defined in node_modules/typed-emitter/index.d.ts:24
Type parameters
- E: keyof ClientEvents
Parameters
- event: E
- listener: ClientEvents[E]
Returns Client

emit

emit<E>(event: E, ...args: Arguments<ClientEvents[E]>): boolean

- Defined in node_modules/typed-emitter/index.d.ts:34
Type parameters
- E: keyof ClientEvents
Parameters
- event: E
- Rest ...args: Arguments<ClientEvents[E]>
Returns boolean

eventNames

eventNames(): (string | symbol)[]

- Defined in node_modules/typed-emitter/index.d.ts:35
Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

- Defined in node_modules/typed-emitter/index.d.ts:40
Returns number

introduce

introduce(host: string, port: number): void

- Defined in src/Client/Client.ts:55
Add a new daemon to the swarm. The client may now give jobs to this daemon.

Parameters
- host: string
  
  hostname or IP address of daemon
- port: number
  
  port number of daemon on the host
Returns void

listenerCount

listenerCount<E>(event: E): number

- Defined in node_modules/typed-emitter/index.d.ts:38
Type parameters
- E: keyof ClientEvents
Parameters
- event: E
Returns number

listeners

listeners<E>(event: E): Function[]

- Defined in node_modules/typed-emitter/index.d.ts:37
Type parameters
- E: keyof ClientEvents
Parameters
- event: E
Returns Function[]

off

off<E>(event: E, listener: ClientEvents[E]): Client

- Defined in node_modules/typed-emitter/index.d.ts:30
Type parameters
- E: keyof ClientEvents
Parameters
- event: E
- listener: ClientEvents[E]
Returns Client

on

on<E>(event: E, listener: ClientEvents[E]): Client

- Defined in node_modules/typed-emitter/index.d.ts:25
Type parameters
- E: keyof ClientEvents
Parameters
- event: E
- listener: ClientEvents[E]
Returns Client

once

once<E>(event: E, listener: ClientEvents[E]): Client

- Defined in node_modules/typed-emitter/index.d.ts:26
Type parameters
- E: keyof ClientEvents
Parameters
- event: E
- listener: ClientEvents[E]
Returns Client

prependListener

prependListener<E>(event: E, listener: ClientEvents[E]): Client

- Defined in node_modules/typed-emitter/index.d.ts:27
Type parameters
- E: keyof ClientEvents
Parameters
- event: E
- listener: ClientEvents[E]
Returns Client

prependOnceListener

prependOnceListener<E>(event: E, listener: ClientEvents[E]): Client

- Defined in node_modules/typed-emitter/index.d.ts:28
Type parameters
- E: keyof ClientEvents
Parameters
- event: E
- listener: ClientEvents[E]
Returns Client

quit

quit(): void

- Defined in src/Client/Client.ts:60
Close all daemons and clean up resources.

Returns void

rawListeners

rawListeners<E>(event: E): Function[]

- Defined in node_modules/typed-emitter/index.d.ts:36
Type parameters
- E: keyof ClientEvents
Parameters
- event: E
Returns Function[]

removeAllListeners

removeAllListeners<E>(event?: E): Client

- Defined in node_modules/typed-emitter/index.d.ts:31
Type parameters
- E: keyof ClientEvents
Parameters
- Optional event: E
Returns Client

removeListener

removeListener<E>(event: E, listener: ClientEvents[E]): Client

- Defined in node_modules/typed-emitter/index.d.ts:32
Type parameters
- E: keyof ClientEvents
Parameters
- event: E
- listener: ClientEvents[E]
Returns Client

setMaxListeners

setMaxListeners(maxListeners: number): Client

- Defined in node_modules/typed-emitter/index.d.ts:41
Parameters
- maxListeners: number
Returns Client

Generated using TypeDoc