SpreadTheWord | spread-the-word

Hierarchy

EventEmitter
- SpreadTheWord

Constructors

constructor

new SpreadTheWord(options?: EventEmitterOptions): SpreadTheWord

- Defined in node_modules/@types/node/events.d.ts:19
Parameters
- Optional options: EventEmitterOptions
Returns SpreadTheWord

Properties

listenersList

listenersList: Listener[] = []

server

server: Server

servicesList

servicesList: Service[] = []

status

status: StatusType = "uninitialized"

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): SpreadTheWord

- Defined in node_modules/@types/node/events.d.ts:57
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SpreadTheWord

destroy

destroy(): Promise<void>

- Defined in src/SpreadTheWord.ts:73
Returns Promise<void>

emit

emit(event: string | symbol, ...args: any[]): boolean

- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

- Defined in node_modules/@types/node/events.d.ts:72
Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

- Defined in node_modules/@types/node/events.d.ts:64
Returns number

init

init(options?: ServerOptions): void

- Defined in src/SpreadTheWord.ts:26
Parameters
- Optional options: ServerOptions
Returns void

listen

listen(options?: ListenerOptions, serverOptions?: ServerOptions): Promise<Listener>

- Defined in src/SpreadTheWord.ts:49
Parameters
- Optional options: ListenerOptions
- Optional serverOptions: ServerOptions
Returns Promise<Listener>

listenerCount

listenerCount(event: string | symbol): number

- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): SpreadTheWord

- Defined in node_modules/@types/node/events.d.ts:61
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SpreadTheWord

on

on(event: "up", callback: (remoteService: RemoteService, response: Response, referrer: Referrer) => void): SpreadTheWord
on(event: "down", callback: (remoteService: RemoteService, response: Response, referrer: Referrer) => void): SpreadTheWord
on(event: "destroy", callback: () => void): SpreadTheWord

- Defined in src/SpreadTheWord.ts:12
Parameters
- event: "up"
- callback: (remoteService: RemoteService, response: Response, referrer: Referrer) => void
  - - (remoteService: RemoteService, response: Response, referrer: Referrer): void
    - Parameters
      - remoteService: RemoteService
      - response: Response
      - referrer: Referrer
      Returns void
Returns SpreadTheWord
- Defined in src/SpreadTheWord.ts:13
Parameters
- event: "down"
- callback: (remoteService: RemoteService, response: Response, referrer: Referrer) => void
  - - (remoteService: RemoteService, response: Response, referrer: Referrer): void
    - Parameters
      - remoteService: RemoteService
      - response: Response
      - referrer: Referrer
      Returns void
Returns SpreadTheWord
- Defined in src/SpreadTheWord.ts:14
Parameters
- event: "destroy"
- callback: () => void
  - - (): void
    - Returns void
Returns SpreadTheWord

once

once(event: "up", callback: (remoteService: RemoteService, response: Response, referrer: Referrer) => void): SpreadTheWord
once(event: "down", callback: (remoteService: RemoteService, response: Response, referrer: Referrer) => void): SpreadTheWord
once(event: "destroy", callback: () => void): SpreadTheWord

- Defined in src/SpreadTheWord.ts:15
Parameters
- event: "up"
- callback: (remoteService: RemoteService, response: Response, referrer: Referrer) => void
  - - (remoteService: RemoteService, response: Response, referrer: Referrer): void
    - Parameters
      - remoteService: RemoteService
      - response: Response
      - referrer: Referrer
      Returns void
Returns SpreadTheWord
- Defined in src/SpreadTheWord.ts:16
Parameters
- event: "down"
- callback: (remoteService: RemoteService, response: Response, referrer: Referrer) => void
  - - (remoteService: RemoteService, response: Response, referrer: Referrer): void
    - Parameters
      - remoteService: RemoteService
      - response: Response
      - referrer: Referrer
      Returns void
Returns SpreadTheWord
- Defined in src/SpreadTheWord.ts:17
Parameters
- event: "destroy"
- callback: () => void
  - - (): void
    - Returns void
Returns SpreadTheWord

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): SpreadTheWord

- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SpreadTheWord

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): SpreadTheWord

- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SpreadTheWord

rawListeners

rawListeners(event: string | symbol): Function[]

- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): SpreadTheWord

- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- Optional event: string | symbol
Returns SpreadTheWord

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): SpreadTheWord

- Defined in node_modules/@types/node/events.d.ts:60
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SpreadTheWord

setMaxListeners

setMaxListeners(n: number): SpreadTheWord

- Defined in node_modules/@types/node/events.d.ts:63
Parameters
- n: number
Returns SpreadTheWord

spread

spread(options: ServiceOptions, serverOptions?: ServerOptions): Promise<Service>

- Defined in src/SpreadTheWord.ts:33
Parameters
- options: ServiceOptions
- Optional serverOptions: ServerOptions
Returns Promise<Service>

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

- Defined in node_modules/@types/node/events.d.ts:26
deprecated
since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

- Defined in node_modules/@types/node/events.d.ts:23
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>

Static once

once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
once(emitter: DOMEventTarget, event: string): Promise<any[]>

- Defined in node_modules/@types/node/events.d.ts:21
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
- Defined in node_modules/@types/node/events.d.ts:22
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: EventEmitterOptions

Returns SpreadTheWord

Properties

listenersList

server

servicesList

status

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns SpreadTheWord

destroy

Returns Promise<void>

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

getMaxListeners

Returns number

init

Parameters

Optional options: ServerOptions

Returns void

listen

Parameters

Optional options: ListenerOptions

Optional serverOptions: ServerOptions

Returns Promise<Listener>

listenerCount

Parameters

event: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

off

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns SpreadTheWord

on

Parameters

event: "up"

callback: (remoteService: RemoteService, response: Response, referrer: Referrer) => void

Parameters

remoteService: RemoteService

response: Response

referrer: Referrer

Returns void

Returns SpreadTheWord

Parameters

event: "down"

callback: (remoteService: RemoteService, response: Response, referrer: Referrer) => void

Parameters

remoteService: RemoteService

response: Response