Interface ITransport

Base interface for all transports

interface ITransport {
    state: TransportState;
    isConnected: boolean;
    send(message): Promise<void>;
    close(reason?): Promise<void>;
    on<K>(event, listener): void;
    off<K>(event, listener): void;
    once<K>(event, listener): void;
}

Hierarchy (view full)

Properties

state isConnected

Methods

send close on off once

Properties

Readonly state

state: TransportState

Current transport state

Readonly isConnected

isConnected: boolean

Whether the transport is currently connected

Methods

send

close

  • close(reason?): Promise<void>

  • Close the transport connection

    Parameters

    • Optional reason: string

      Optional reason for closing

    Returns Promise<void>

on

  • on<K>(event, listener): void

  • Register an event listener

    Type Parameters

    Parameters

    • event: K
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: unknown[]

          Returns void

    Returns void

off

  • off<K>(event, listener): void

  • Remove an event listener

    Type Parameters

    Parameters

    • event: K
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: unknown[]

          Returns void

    Returns void

once

  • once<K>(event, listener): void

  • Register a one-time event listener

    Type Parameters

    Parameters

    • event: K
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: unknown[]

          Returns void

    Returns void

Settings

Member Visibility

Theme

On This Page

stateisConnectedsendcloseonoffonce