Class Protomux<TStream>

constructor

• new Protomux<TStream>(stream): Protomux<TStream>

• Type Parameters

  • TStream extends Duplex | Duplex<any, any, any, any, true, true, DuplexEvents<any, any>> = Duplex<any, any, any, any, true, true, DuplexEvents<any, any>>

  Parameters

  • stream: TStream

  Returns Protomux<TStream>

isProtomux

stream

[iterator]

• [iterator](): IterableIterator<Channel, any, any>

• Returns IterableIterator<Channel, any, any>

cork

• cork(): void

• Returns void

createChannel

• createChannel(opts): Channel

• Parameters

  • opts: {
        aliases?: string[];
        handshake?: any;
        id?: null | Buffer;
        messages: Partial<Pick<Message, "onmessage" | "encoding">>[];
        protocol: string;
        unique?: boolean;
        userData?: any;
        onclose?(): void | Promise<void>;
        ondestroy?(): void | Promise<void>;
        onopen?(handshake?: any): void | Promise<void>;
    }

    • Optionalaliases?: string[]

    • Optionalhandshake?: any

    • Optionalid?: null | Buffer

    • messages: Partial<Pick<Message, "onmessage" | "encoding">>[]

    • protocol: string

    • Optionalunique?: boolean

    • OptionaluserData?: any

    • onclose?:function

      • onclose(): void | Promise<void>

      • Returns void | Promise<void>

    • ondestroy?:function

      • ondestroy(): void | Promise<void>

      • Returns void | Promise<void>

    • onopen?:function

      • onopen(handshake?): void | Promise<void>

      • Parameters

        • Optionalhandshake: any

        Returns void | Promise<void>

  Returns Channel

destroy

• destroy(err): void

• Parameters

  • err: Error

  Returns void

opened

• opened(opts): boolean

• Parameters

  • opts: {
        id?: null | Buffer;
        protocol: string;
    }

    • Optionalid?: null | Buffer

    • protocol: string

  Returns boolean

pair

• pair(opts, notify): void

• Parameters

  • opts: {
        id?: null | Buffer;
        protocol: string;
    }

    • Optionalid?: null | Buffer

    • protocol: string

  • notify: ((id: Buffer) => Promise<void>)
    • • (id): Promise<void>

      • Parameters

        • id: Buffer

        Returns Promise<void>

  Returns void

uncork

• uncork(): void

• Returns void

unpair

• unpair(opts): void

• Parameters

  • opts: {
        id?: null | Buffer;
        protocol: string;
    }

    • Optionalid?: null | Buffer

    • protocol: string

  Returns void

Staticfrom

• from(stream): Protomux<TStream>

• Parameters

  • stream: TStream

  Returns Protomux<TStream>

StaticisProtomux

• isProtomux(mux): mux is Protomux<Duplex<any, any, any, any, true, true, DuplexEvents<any, any>>>

• Parameters

  • mux: unknown

  Returns mux is Protomux<Duplex<any, any, any, any, true, true, DuplexEvents<any, any>>>