Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Unit

Unit represents remote peer.

This class should not be instantiated directly. It is exposed for type declaration and documentation

Hierarchy

  • EventEmitter
    • Unit

Index

Events

Properties

Accessors

Methods

Events

on

  • on(event: "close", handler: () => void): Unit
  • on(event: "error", handler: () => void): Unit

  • Event 'close' is dispatched when last connection gets closed

    Parameters

    • event: "close"
    • handler: () => void
        • (): void

        • Returns void

    Returns Unit

  • Event 'error' is dispatched when something goes wrong with unit. After error unit gets closed

    Parameters

    • event: "error"
    • handler: () => void
        • (): void

        • Returns void

    Returns Unit

Properties

Readonly id

id: string

Unique identifier for unit. This value is generated when remote Peer gets instantiated

Readonly Static captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Readonly Static 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.

Accessors

meta

name

  • get name(): undefined | string

  • Name assigned to remote peer

    Returns undefined | string

Methods

addListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Unit

close

  • close(): void

  • Close all underlying connections. After last connect gets closed, event 'close' is emitted

    Returns void

emit

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

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

getRoles

  • getRoles(): string[]

  • Returns all roles registered on remote peer which are not disabled

    Returns string[]

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

off

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Unit

once

  • once(event: string | symbol, listener: (...args: any[]) => void): Unit

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Unit

prependListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Unit

prependOnceListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Unit

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): Unit

  • Parameters

    • Optional event: string | symbol

    Returns Unit

removeListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Unit

setMaxListeners

  • setMaxListeners(n: number): Unit

  • Parameters

    • n: number

    Returns Unit

Static listenerCount

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

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

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

  • 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[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string

    Returns Promise<any[]>

Generated using TypeDoc