ogs-plugin-sdk
    Preparing search index...

    Interface WebSocket

    interface WebSocket {
        on(
            event: "message",
            listener: (d: string | ArrayBufferLike) => void,
        ): this;
        on(event: "connect", listener: () => void): this;
        on(event: "close", listener: () => void): this;
        on(event: "error", listener: (e: Error) => void): this;
        off(event: "message", listener: (d: string) => void): this;
        off(event: "connect", listener: () => void): this;
        off(event: "close", listener: () => void): this;
        off(event: "error", listener: (e: Error) => void): this;
        send(data: string | ArrayBufferLike): void;
    }
    Index

    Methods

    on off send

    Methods

    • Emitted when a new message is received

      Parameters

      • event: "message"
      • listener: (d: string | ArrayBufferLike) => void

      Returns this

    • Emitted when a socket connection is successfully established

      Parameters

      • event: "connect"
      • listener: () => void

      Returns this

    • Emitted once the socket is fully closed

      Parameters

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

      Returns this

    • Emitted when an error occurs

      Parameters

      • event: "error"
      • listener: (e: Error) => void

      Returns this

    • Parameters

      • event: "message"
      • listener: (d: string) => void

      Returns this

    • Parameters

      • event: "connect"
      • listener: () => void

      Returns this

    • Parameters

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

      Returns this

    • Parameters

      • event: "error"
      • listener: (e: Error) => void

      Returns this

    • Parameters

      • data: string | ArrayBufferLike

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods