Interface WebSocketProvider

Hierarchy

  • WebSocketProvider

Properties

key onclose? onerror? onmessage? onmessageJSON? onopen? topic? websocket?

Properties

key

key: string

Unique identifier for the WebSocket subscriber.

Optional onclose

onclose?: ((event) => void)

Type declaration

    • (event): void

    • Event listener called when the WebSocket connection is closed.

      Parameters

      • event: Event

      Returns void

Optional onerror

onerror?: ((error) => void)

Type declaration

    • (error): void

    • Event listener called when an error occurs on the WebSocket connection.

      Parameters

      • error: Event

      Returns void

Optional onmessage

onmessage?: ((data) => void)

Type declaration

    • (data): void

    • Event listener called when a message is received from the server.

      Parameters

      • data: string

      Returns void

Optional onmessageJSON

onmessageJSON?: ((data) => void)

Type declaration

    • (data): void

    • Event listener called when a JSON message is received from the server.

      Parameters

      • data: JSON

      Returns void

Optional onopen

onopen?: (() => void)

Type declaration

    • (): void

    • Event listener called when the WebSocket connection is opened.

      Returns void

Optional topic

topic?: string

Optional identifier for a specific WebSocket topic.

Optional websocket

websocket?: default

Instance of the ReconnectingWebSocket associated with this subscriber.

Settings

Member Visibility

Theme

On This Page