Interface IStream

A bi-directional byte stream that allows for sending an receiving any kind of data.

interface IStream {
    addEventListener<T extends keyof PeerkitStreamEvents>(
        type: T,
        listener: PeerkitStreamEvents[T],
    ): void;
    close(): Promise<void>;
    isOpen(): boolean;
    removeEventListener<T extends keyof PeerkitStreamEvents>(
        type: T,
        listener: PeerkitStreamEvents[T],
    ): void;
    send(data: Uint8Array): void;
}

Index

Methods

addEventListener close isOpen removeEventListener send

Methods

addEventListener

addEventListener<T extends keyof PeerkitStreamEvents>(
type: T,
listener: PeerkitStreamEvents[T],
): void
Register an event listener for the stream.
Type Parameters
- T extends keyof PeerkitStreamEvents
Parameters
- type: T
- listener: PeerkitStreamEvents[T]
Returns void
- Defined in transport.ts:112

close

close(): Promise<void>
Close the stream.

Returns Promise<void>
- Defined in transport.ts:133

isOpen

isOpen(): boolean
Is this stream open?

Returns boolean
- Defined in transport.ts:128

removeEventListener

removeEventListener<T extends keyof PeerkitStreamEvents>(
type: T,
listener: PeerkitStreamEvents[T],
): void
Remove an event listener from the stream.
Type Parameters
- T extends keyof PeerkitStreamEvents
Parameters
- type: T
- listener: PeerkitStreamEvents[T]
Returns void
- Defined in transport.ts:120

send

send(data: Uint8Array): void
Send data over the stream.
Parameters
- data: Uint8Array
Returns void
- Defined in transport.ts:107