Class TpWebSocket

constructor

• new TpWebSocket(_socket): TpWebSocket

• Parameters

  • _socket: WebSocket

  Returns TpWebSocket

Static event_need_to_wrap

close

• close(code?, data?): void

• Parameters

  • Optional code: number

  • Optional data: string | Buffer

  Returns void

off

• off(event): TpWebSocket

• Parameters

  • event: EventNeedToWrap

  Returns TpWebSocket

on

• on(event, listener): TpWebSocket

• Parameters

  • event: "close"

  • listener: ((code, reason) => void)

    • • (code, reason): void

      • Parameters

        • code: number

        • reason: Buffer

        Returns void

  Returns TpWebSocket

• on(event, listener): TpWebSocket

• Parameters

  • event: "error"

  • listener: ((err) => void)

    • • (err): void

      • Parameters

        • err: Error

        Returns void

  Returns TpWebSocket

• on(event, listener): TpWebSocket

• Parameters

  • event: "message"

  • listener: ((data, isBinary) => void)

    • • (data, isBinary): void

      • Parameters

        • data: Buffer

        • isBinary: boolean

        Returns void

  Returns TpWebSocket

on_listener_error

• on_listener_error(handler): void

• Parameters

  • handler: ListenerErrorHandler

  Returns void

once

• once(event, listener): TpWebSocket

• Parameters

  • event: "close"

  • listener: ((code, reason) => void)

    • • (code, reason): void

      • Parameters

        • code: number

        • reason: Buffer

        Returns void

  Returns TpWebSocket

• once(event, listener): TpWebSocket

• Parameters

  • event: "error"

  • listener: ((err) => void)

    • • (err): void

      • Parameters

        • err: Error

        Returns void

  Returns TpWebSocket

• once(event, listener): TpWebSocket

• Parameters

  • event: "message"

  • listener: ((data, isBinary) => void)

    • • (data, isBinary): void

      • Parameters

        • data: Buffer

        • isBinary: boolean

        Returns void

  Returns TpWebSocket

send

• send(data): Promise<undefined | Error>

• Parameters

  • data: BufferLike

  Returns Promise<undefined | Error>

• send(data, options?): Promise<undefined | Error>

• Parameters

  • data: BufferLike

  • Optional options: SendMessageOptions

  Returns Promise<undefined | Error>

terminate

• terminate(): void

• Returns void