Interface TransportEvents

interface TransportEvents {
    connect: (() => void);
    close: ((reason?) => void);
    error: ((error) => void);
    message: ((message) => void);
    drain: (() => void);
    reconnecting: ((attempt) => void);
    reconnected: (() => void);
}

Properties

connect close error message drain reconnecting reconnected

Properties

connect

connect: (() => void)

Emitted when connection is established

Type declaration

    • (): void

    • Returns void

close

close: ((reason?) => void)

Emitted when connection is closed

Type declaration

    • (reason?): void

    • Parameters

      • Optional reason: string

      Returns void

error

error: ((error) => void)

Emitted on transport error

Type declaration

    • (error): void

    • Parameters

      • error: Error

      Returns void

message

message: ((message) => void)

Emitted when a message is received

Type declaration

drain

drain: (() => void)

Emitted when transport is ready to send (after backpressure relief)

Type declaration

    • (): void

    • Returns void

reconnecting

reconnecting: ((attempt) => void)

Emitted on reconnection attempt (client only)

Type declaration

    • (attempt): void

    • Parameters

      • attempt: number

      Returns void

reconnected

reconnected: (() => void)

Emitted when reconnection succeeds (client only)

Type declaration

    • (): void

    • Returns void

Settings

Member Visibility

Theme

On This Page

connectcloseerrormessagedrainreconnectingreconnected