Class Peer

Represents a peer connection. Do not create Peer instances manually.

Index

Accessors

channels connection id metadata state streams

Methods

close dispose emit off on once open send share toJSON unshare

Accessors

channels

get channels(): ReadonlyMap<string, RTCDataChannel>
Negotiated data channels keyed by channel label.

Returns ReadonlyMap<string, RTCDataChannel>
- Defined in src/peer.ts:54

connection

get connection(): RTCPeerConnection
Native WebRTC peer connection to the peer.

Returns RTCPeerConnection
- Defined in src/peer.ts:46

id

get id(): string
Peer identifier.

Returns string
- Defined in src/peer.ts:34

metadata

get metadata(): Record<string, unknown> | undefined
Metadata advertised by the peer.

Returns Record<string, unknown> | undefined
- Defined in src/peer.ts:38

state

get state(): ConnectionState
Peer connection state, updated on connection state changes.

Returns ConnectionState
- Defined in src/peer.ts:42

streams

get streams(): ReadonlyMap<string, MediaStream>
Remote media streams keyed by stream label.

Returns ReadonlyMap<string, MediaStream>
- Defined in src/peer.ts:50

Methods

close

close(options: string | { label?: string }): Promise<void>
Closes a previously opened data channel to the current peer.
Parameters
- options: string | { label?: string }
  Channel label or object containing label.
Returns Promise<void>
Example
```
// close the channel with label "chat"
await peer.close({ label: "chat" });
```
- Defined in src/peer.ts:403

dispose

dispose(): void
Closes and frees all connection resources.

Returns void
- Defined in src/peer.ts:598

emit

emit<K extends keyof PeerEvents>(event: K | K[], ...args: PeerEvents[K]): void
Emits one or more events. Typically, you would not call this method directly.
Type Parameters
- K extends keyof PeerEvents
Parameters
- event: K | K[]
  Event name or list of event names.
- ...args: PeerEvents[K]
  Event payload.
Returns void
- Defined in src/peer.ts:588

off

off<K extends keyof PeerEvents>(
event: K | K[],
handler?: (...args: PeerEvents[K]) => void,
): void
Removes a previously registered event listener.
Type Parameters
- K extends keyof PeerEvents
Parameters
- event: K | K[]
  Event name or list of event names.
- Optionalhandler: (...args: PeerEvents[K]) => void
  Event handler to remove. If omitted, all handlers for the given event(s) will be removed.
Returns void
- Defined in src/peer.ts:574

on

on<K extends keyof PeerEvents>(
event: K | K[],
handler: (...args: PeerEvents[K]) => void,
): void
Subscribes to one or more peer events.
Type Parameters
- K extends keyof PeerEvents
Parameters
- event: K | K[]
  Event name or list of event names.
- handler: (...args: PeerEvents[K]) => void
  Event handler.
Returns void
Example
```
// subscribe to the "connection" event
peer.on("connection", (e) => {
  console.log("Connection state has changed:", e.state);
});
```
- Defined in src/peer.ts:548

once

once<K extends keyof PeerEvents>(
event: K | K[],
handler: (...args: PeerEvents[K]) => void,
): void
Subscribes to an event and auto-unsubscribes after first invocation.
Type Parameters
- K extends keyof PeerEvents
Parameters
- event: K | K[]
  Event name or list of event names.
- handler: (...args: PeerEvents[K]) => void
  Event handler.
Returns void
- Defined in src/peer.ts:561

open

open(options: string | ChannelOptions): Promise<void>
Opens a data channel to the current peer.

If a channel with the same label already exists, it will be reused.

You can open a channel with the same label on both local and remote peers or only on one side. In any case, only one channel will be created for each label. You can send data through the channel in both directions.
Parameters
- options: string | ChannelOptions
  Channel options or channel label.
Returns Promise<void>
Example
```
// open a channel with label "chat"
await peer.open({ label: "chat" });
```
- Defined in src/peer.ts:381

send

send(
message: unknown,
options?: string | SendOptions,
): ReadableStream<TransferProgress> & Promise<void>

Sends a message through a data channel.

If options is a string, it is treated as the channel label. If no label is provided, it uses the default channel.

The send method works only with open channels that have no protocol specified, are ordered (reliable), and match the specified label.

Parameters

message: unknown
Message payload to send.
Optionaloptions: string | SendOptions
Send options or channel label.

Returns ReadableStream<TransferProgress> & Promise<void>

A ReadableStream of transfer progress status or a Promise.

Example

// send a message to default channel
await peer.send("Hello, peer!");
// send large data with a progress handler
const file = new File([new Uint8Array(1024 * 1024)], "example.dat");
const transfer = peer.send(file, {
  label: "chat", // channel label
  info: { filename: file.name }, // metadata
  signal: AbortSignal.timeout(10000), // abort signal
});
// optionally handle the progress
for await (const progress of transfer) {
  const { id, label, current, total } = progress;
  const percent = Math.round((current / total) * 100);
  console.log(`[${id}:${label}] Sending... ${percent}%`);
}

share(options: MediaStream | StreamOptions): Promise<void>
Shares a new media stream to the current peer or updates an existing one.

If you pass a MediaStream instance directly, it will be shared under a label equal to the stream id. Otherwise, you can specify an explicit label in the options object. If a stream with the same label already exists, it will be updated and its tracks will be added/removed as needed to minimize renegotiations.
Parameters
- options: MediaStream | StreamOptions
  Stream descriptor or MediaStream instance.
Returns Promise<void>
Example
```
// get a media stream from the user's camera and microphone
const stream = await navigator.mediaDevices.getUserMedia({
  video: true, audio: true
});

// share a media stream with an explicit label
await peer.share({ label: "camera", stream });
```
- Defined in src/peer.ts:262

toJSON

toJSON(): {
    channels: string[];
    id: string;
    metadata?: Record<string, unknown>;
    state: ConnectionState;
    streams: string[];
}
Serializes the peer to a JSON-compatible object.

Returns {
    channels: string[];
    id: string;
    metadata?: Record<string, unknown>;
    state: ConnectionState;
    streams: string[];
}
A serializable representation of the peer.
- Defined in src/peer.ts:622

unshare

unshare(options: string | MediaStream | { label?: string }): Promise<void>
Stops sharing a previously shared media stream to the current peer.

If you pass a MediaStream instance directly, it will be unshared using its id as the label. Otherwise, you can specify the label in the options object or pass it directly as a string.
Parameters
- options: string | MediaStream | { label?: string }
  A stream label, MediaStream instance, or an object containing a label.
Returns Promise<void>
Example
```
// unshare a media stream with an explicit label
await peer.unshare({ label: "camera" });
```
- Defined in src/peer.ts:338

Class Peer

Index

Accessors

Methods

Accessors

channels

Returns ReadonlyMap<string, RTCDataChannel>

connection

Returns RTCPeerConnection

id

Returns string

metadata

Returns Record<string, unknown> | undefined

state

Returns ConnectionState

streams

Returns ReadonlyMap<string, MediaStream>

Methods

close

Parameters

Returns Promise<void>

Example

dispose

Returns void

emit

Type Parameters

Parameters

Returns void

off

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns void

Example

once

Type Parameters

Parameters

Returns void

open

Parameters

Returns Promise<void>

Example

send

Parameters

Returns ReadableStream<TransferProgress> & Promise<void>

Example

share

Parameters

Returns Promise<void>

Example

toJSON

Returns { channels: string[]; id: string; metadata?: Record<string, unknown>; state: ConnectionState; streams: string[];}

unshare

Parameters

Returns Promise<void>

Example

Settings

On This Page

Returns {
channels: string[];
id: string;
metadata?: Record<string, unknown>;
state: ConnectionState;
streams: string[];
}