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

Hierarchy

EventEmitter<PeerStreamEvents>
- PeerStreams

Index

Properties

#private attachInboundStream attachOutboundStream close id inboundStream? isWritable outboundStream? protocol write

Methods

addEventListener dispatchEvent listenerCount removeEventListener safeDispatchEvent

Properties

`Private` #private

#private: any

attachInboundStream

attachInboundStream: ((stream: Stream) => AsyncIterable<Uint8ArrayList>)

Type declaration

- (stream: Stream): AsyncIterable<Uint8ArrayList>
- Parameters
  - stream: Stream
  Returns AsyncIterable<Uint8ArrayList>

attachOutboundStream

attachOutboundStream: ((stream: Stream) => Promise<Pushable<Uint8ArrayList, void, unknown>>)

Type declaration

- (stream: Stream): Promise<Pushable<Uint8ArrayList, void, unknown>>
- Parameters
  - stream: Stream
  Returns Promise<Pushable<Uint8ArrayList, void, unknown>>

close

close: (() => void)

Type declaration

- (): void
- Returns void

id

`Optional` inboundStream

inboundStream?: AsyncIterable<Uint8ArrayList>

isWritable

isWritable: boolean

`Optional` outboundStream

outboundStream?: Pushable<Uint8ArrayList, void, unknown>

protocol

protocol: string

write

write: ((buf: Uint8Array | Uint8ArrayList) => void)

Type declaration

- (buf: Uint8Array | Uint8ArrayList): void
- Parameters
  - buf: Uint8Array | Uint8ArrayList
  Returns void

Methods

addEventListener

addEventListener<K>(type: K, listener: null | EventHandler<PeerStreamEvents[K]>, options?: boolean | AddEventListenerOptions): void
Type Parameters
- K extends keyof PeerStreamEvents
Parameters
- type: K
- listener: null | EventHandler<PeerStreamEvents[K]>
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from EventEmitter.addEventListener
- Defined in packages/interfaces/dist/src/events.d.ts:19

dispatchEvent

dispatchEvent(event: Event): boolean
Parameters
- event: Event
Returns boolean
Inherited from EventEmitter.dispatchEvent
- Defined in packages/interfaces/dist/src/events.d.ts:21

listenerCount

listenerCount(type: string): number
Parameters
- type: string
Returns number
Inherited from EventEmitter.listenerCount
- Defined in packages/interfaces/dist/src/events.d.ts:18

removeEventListener

removeEventListener<K>(type: K, listener?: null | EventHandler<PeerStreamEvents[K]>, options?: boolean | EventListenerOptions): void
Type Parameters
- K extends keyof PeerStreamEvents
Parameters
- type: K
- Optional listener: null | EventHandler<PeerStreamEvents[K]>
- Optional options: boolean | EventListenerOptions
Returns void
Inherited from EventEmitter.removeEventListener
- Defined in packages/interfaces/dist/src/events.d.ts:20

safeDispatchEvent

safeDispatchEvent<Detail>(type: keyof PeerStreamEvents, detail: CustomEventInit<Detail>): boolean
Type Parameters
- Detail
Parameters
- type: keyof PeerStreamEvents
- detail: CustomEventInit<Detail>
Returns boolean
Inherited from EventEmitter.safeDispatchEvent
- Defined in packages/interfaces/dist/src/events.d.ts:22