Interface Channel

interface Channel {
    closed: boolean;
    destroyed: boolean;
    id: Buffer;
    messages: Message[];
    opened: boolean;
    protocol: string;
    userData: any;
    addMessage(opts?: Partial<Pick<Message, "onmessage" | "encoding">>): Message;
    close(): void;
    cork(): void;
    open(handshake?: any): void;
    uncork(): void;
}

Index

Properties

closed destroyed id messages opened protocol userData

Methods

addMessage close cork open uncork

Properties

closed

closed: boolean

destroyed

destroyed: boolean

id

id: Buffer

messages

messages: Message[]

opened

opened: boolean

protocol

protocol: string

userData

userData: any

Methods

addMessage

addMessage(opts?): Message
Parameters
- Optionalopts: Partial<Pick<Message, "onmessage" | "encoding">>
Returns Message

close

close(): void
Returns void

cork

cork(): void
Returns void

open

open(handshake?): void
Parameters
- Optionalhandshake: any
Returns void

uncork

uncork(): void
Returns void