Interface PeerStreams

Adds types to the EventTarget class. Hopefully this won't be necessary forever.

https://github.com/microsoft/TypeScript/issues/28357 https://github.com/microsoft/TypeScript/issues/43477 https://github.com/microsoft/TypeScript/issues/299 etc

interface PeerStreams {
    id: PeerId;
    inboundStream?: AsyncIterable<Uint8ArrayList>;
    isWritable: boolean;
    outboundStream?: Pushable<Uint8ArrayList, void, unknown>;
    protocol: string;
    addEventListener<K>(type, listener, options?): void;
    attachInboundStream(stream): AsyncIterable<Uint8ArrayList>;
    attachOutboundStream(stream): Promise<Pushable<Uint8ArrayList, void, unknown>>;
    close(): void;
    dispatchEvent(event): boolean;
    dispatchEvent(event): boolean;
    listenerCount(type): number;
    removeEventListener<K>(type, listener?, options?): void;
    removeEventListener(type, listener?, options?): void;
    safeDispatchEvent<Detail>(type, detail): boolean;
    write(buf): void;
}

Hierarchy (view full)

Properties

id inboundStream? isWritable outboundStream? protocol

Methods

addEventListener attachInboundStream attachOutboundStream close dispatchEvent listenerCount removeEventListener safeDispatchEvent write

Properties

id

id: PeerId

Optional inboundStream

inboundStream?: AsyncIterable<Uint8ArrayList>

isWritable

isWritable: boolean

Optional outboundStream

outboundStream?: Pushable<Uint8ArrayList, void, unknown>

protocol

protocol: string

Methods

addEventListener

attachInboundStream

attachOutboundStream

close

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    Returns boolean

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    Returns boolean

listenerCount

removeEventListener

safeDispatchEvent

write

Settings

Member Visibility

Theme

On This Page

idinboundStreamisWritableoutboundStreamprotocoladdEventListenerattachInboundStreamattachOutboundStreamclosedispatchEventlistenerCountremoveEventListenersafeDispatchEventwrite