NodeAV

Appearance

node-av / webrtc / RTCPeerConnection

Class: RTCPeerConnection ​

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:37

W3C compatibility notes kept near the public RTCPeerConnection surface so the reviewable diff does not depend on external PR text.

  • current/pending*Description, canTrickleIceCandidates, sctp, addIceCandidate(null), and RTCConfiguration round-trip behavior are implemented here and covered by tests/wpt/peerConnectionApiCompatibility.test.ts.
  • addIceCandidate() also validates sdpMid / sdpMLineIndex / usernameFragment against the applied remote description and appends candidates or end-of-candidates markers to the corresponding m-section. The public API keeps werift's historical pre-SRD buffering behavior, while the WPT runner wraps the class to exercise strict spec rejection.
  • bundlePolicy: "balanced" is accepted for input compatibility but is normalized to werift's "max-compat" behavior, so getConfiguration() returns the normalized value.
  • setLocalDescription() keeps the historical SessionDescription return value for non-rollback calls, while { type: "rollback" } resolves void to match the actual behavior without pretending to return a description.
  • API reference markdown is regenerated with cd packages/webrtc && npm run doc. The generated output lives under packages/webrtc/doc/; compatibility notes remain here and in the package README so review context is visible even when generated docs are not committed in the same change.

Extends ​

  • EventTarget

Constructors ​

Constructor ​

new RTCPeerConnection(config?): RTCPeerConnection

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:83

Parameters ​

config? ​

RTCPeerConnectionConfig

Returns ​

RTCPeerConnection

Overrides ​

EventTarget.constructor

Properties ​

addEventListener ​

addEventListener: (type, listener, options?) => void

Defined in: node_modules/werift/lib/webrtc/src/helper.d.ts:15

Parameters ​

type ​

string

listener ​

(...args) => void

options? ​

boolean | { once?: boolean; }

Returns ​

void

Inherited from ​

EventTarget.addEventListener

cname ​

readonly cname: string

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:39

config ​

config: Required<PeerConfig>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:40

connectionStateChange ​

readonly connectionStateChange: Event<["new" | "closed" | "disconnected" | "connected" | "failed" | "connecting"]>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:57

dispatchEvent ​

dispatchEvent: (event) => boolean

Defined in: node_modules/werift/lib/webrtc/src/helper.d.ts:19

Parameters ​

event ​

Event

Returns ​

boolean

Inherited from ​

EventTarget.dispatchEvent

iceConnectionStateChange ​

readonly iceConnectionStateChange: Event<["new" | "closed" | "disconnected" | "connected" | "failed" | "checking" | "completed"]>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:55

iceGatheringStateChange ​

readonly iceGatheringStateChange: Event<["new" | "gathering" | "complete"]>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:54

id ​

readonly id: string

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:38

needRestart ​

needRestart: boolean

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:43

negotiationneeded ​

negotiationneeded: boolean

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:42

onDataChannel ​

readonly onDataChannel: Event<[RTCDataChannel]>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:58

onIceCandidate ​

readonly onIceCandidate: Event<[RTCIceCandidate | undefined]>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:61

onNegotiationneeded ​

readonly onNegotiationneeded: Event<[]>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:62

onRemoteTransceiverAdded ​

readonly onRemoteTransceiverAdded: Event<[RTCRtpTransceiver]>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:59

onTrack ​

readonly onTrack: Event<[MediaStreamTrack]>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:63

onTransceiverAdded ​

readonly onTransceiverAdded: Event<[RTCRtpTransceiver]>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:60

removeEventListener ​

removeEventListener: (type, listener) => void

Defined in: node_modules/werift/lib/webrtc/src/helper.d.ts:18

Parameters ​

type ​

string

listener ​

(...args) => void

Returns ​

void

Inherited from ​

EventTarget.removeEventListener

signalingState ​

signalingState: "closed" | "stable" | "have-local-offer" | "have-remote-offer" | "have-local-pranswer" | "have-remote-pranswer"

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:41

signalingStateChange ​

readonly signalingStateChange: Event<["closed" | "stable" | "have-local-offer" | "have-remote-offer" | "have-local-pranswer" | "have-remote-pranswer"]>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:56

Accessors ​

canTrickleIceCandidates ​

Get Signature ​

get canTrickleIceCandidates(): boolean | null

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:103

Returns ​

boolean | null

connectionState ​

Get Signature ​

get connectionState(): "new" | "closed" | "disconnected" | "connected" | "failed" | "connecting"

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:84

Returns ​

"new" | "closed" | "disconnected" | "connected" | "failed" | "connecting"

currentLocalDescription ​

Get Signature ​

get currentLocalDescription(): RTCSessionDescription | null

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:98

Returns ​

RTCSessionDescription | null

currentRemoteDescription ​

Get Signature ​

get currentRemoteDescription(): RTCSessionDescription | null

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:101

Returns ​

RTCSessionDescription | null

dtlsTransports ​

Get Signature ​

get dtlsTransports(): RTCDtlsTransport[]

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:88

Returns ​

RTCDtlsTransport[]

extIdUriMap ​

Get Signature ​

get extIdUriMap(): object

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:93

Returns ​

object

iceConnectionState ​

Get Signature ​

get iceConnectionState(): "new" | "closed" | "disconnected" | "connected" | "failed" | "checking" | "completed"

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:85

Returns ​

"new" | "closed" | "disconnected" | "connected" | "failed" | "checking" | "completed"

iceGathererState ​

Get Signature ​

get iceGathererState(): "new" | "gathering" | "complete"

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:86

Returns ​

"new" | "gathering" | "complete"

iceGatheringState ​

Get Signature ​

get iceGatheringState(): "new" | "gathering" | "complete"

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:87

Returns ​

"new" | "gathering" | "complete"

iceGeneration ​

Get Signature ​

get iceGeneration(): number

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:96

Returns ​

number

iceTransports ​

Get Signature ​

get iceTransports(): RTCIceTransport[]

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:92

Returns ​

RTCIceTransport[]

localDescription ​

Get Signature ​

get localDescription(): RTCSessionDescription | null

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:97

Returns ​

RTCSessionDescription | null

onconnectionstatechange ​

Get Signature ​

get onconnectionstatechange(): Callback

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:79

Returns ​

Callback

Set Signature ​

set onconnectionstatechange(value): void

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:80

Parameters ​
value ​

Callback

Returns ​

void

ondatachannel ​

Get Signature ​

get ondatachannel(): CallbackWithValue<RTCDataChannelEvent>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:65

Returns ​

CallbackWithValue<RTCDataChannelEvent>

Set Signature ​

set ondatachannel(value): void

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:66

Parameters ​
value ​

CallbackWithValue<RTCDataChannelEvent>

Returns ​

void

onicecandidate ​

Get Signature ​

get onicecandidate(): CallbackWithValue<RTCPeerConnectionIceEvent>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:67

Returns ​

CallbackWithValue<RTCPeerConnectionIceEvent>

Set Signature ​

set onicecandidate(value): void

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:68

Parameters ​
value ​

CallbackWithValue<RTCPeerConnectionIceEvent>

Returns ​

void

onicecandidateerror ​

Get Signature ​

get onicecandidateerror(): CallbackWithValue<any>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:69

Returns ​

CallbackWithValue<any>

Set Signature ​

set onicecandidateerror(value): void

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:70

Parameters ​
value ​

CallbackWithValue<any>

Returns ​

void

oniceconnectionstatechange ​

Get Signature ​

get oniceconnectionstatechange(): Callback

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:81

Returns ​

Callback

Set Signature ​

set oniceconnectionstatechange(value): void

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:82

Parameters ​
value ​

Callback

Returns ​

void

onicegatheringstatechange ​

Get Signature ​

get onicegatheringstatechange(): CallbackWithValue<any>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:71

Returns ​

CallbackWithValue<any>

Set Signature ​

set onicegatheringstatechange(value): void

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:72

Parameters ​
value ​

CallbackWithValue<any>

Returns ​

void

onnegotiationneeded ​

Get Signature ​

get onnegotiationneeded(): CallbackWithValue<any>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:73

Returns ​

CallbackWithValue<any>

Set Signature ​

set onnegotiationneeded(value): void

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:74

Parameters ​
value ​

CallbackWithValue<any>

Returns ​

void

onsignalingstatechange ​

Get Signature ​

get onsignalingstatechange(): CallbackWithValue<any>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:75

Returns ​

CallbackWithValue<any>

Set Signature ​

set onsignalingstatechange(value): void

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:76

Parameters ​
value ​

CallbackWithValue<any>

Returns ​

void

ontrack ​

Get Signature ​

get ontrack(): CallbackWithValue<RTCTrackEvent>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:77

Returns ​

CallbackWithValue<RTCTrackEvent>

Set Signature ​

set ontrack(value): void

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:78

Parameters ​
value ​

CallbackWithValue<RTCTrackEvent>

Returns ​

void

pendingLocalDescription ​

Get Signature ​

get pendingLocalDescription(): RTCSessionDescription | null

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:99

Returns ​

RTCSessionDescription | null

pendingRemoteDescription ​

Get Signature ​

get pendingRemoteDescription(): RTCSessionDescription | null

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:102

Returns ​

RTCSessionDescription | null

remoteDescription ​

Get Signature ​

get remoteDescription(): RTCSessionDescription | null

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:100

Returns ​

RTCSessionDescription | null

remoteIsBundled ​

Get Signature ​

get remoteIsBundled(): GroupDescription | undefined

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:104

Returns ​

GroupDescription | undefined

sctp ​

Get Signature ​

get sctp(): RTCSctpTransport | null

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:90

Returns ​

RTCSctpTransport | null

sctpRemotePort ​

Get Signature ​

get sctpRemotePort(): number | undefined

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:91

Returns ​

number | undefined

sctpTransport ​

Get Signature ​

get sctpTransport(): RTCSctpTransport | undefined

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:89

Returns ​

RTCSctpTransport | undefined

Methods ​

[captureRejectionSymbol]()? ​

optional [captureRejectionSymbol](error, event, ...args): void

Defined in: node_modules/@types/node/events.d.ts:87

The Symbol.for('nodejs.rejection') method is called in case a promise rejection happens when emitting an event and captureRejections is enabled on the emitter. It is possible to use events.captureRejectionSymbol in place of Symbol.for('nodejs.rejection').

js
import { EventEmitter, captureRejectionSymbol } from 'node:events';

class MyClass extends EventEmitter {
  constructor() {
    super({ captureRejections: true });
  }

  [captureRejectionSymbol](err, event, ...args) {
    console.log('rejection happened for', event, 'with', err, ...args);
    this.destroy(err);
  }

  destroy(err) {
    // Tear the resource down here.
  }
}

Parameters ​

error ​

Error

event ​

string | symbol

args ​

...any[]

Returns ​

void

Since ​

v13.4.0, v12.16.0

Inherited from ​

EventTarget.[captureRejectionSymbol]

addIceCandidate() ​

addIceCandidate(candidateMessage?): Promise<void>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:187

Parameters ​

candidateMessage? ​

RTCIceCandidate | RTCIceCandidateInit | null

Returns ​

Promise<void>

addListener() ​

addListener<E>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:92

Alias for emitter.on(eventName, listener).

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

listener ​

(...args) => void

Returns ​

this

Since ​

v0.1.26

Inherited from ​

EventTarget.addListener

addTrack() ​

addTrack(track, ...streams): RTCRtpSender

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:194

Parameters ​

track ​

MediaStreamTrack

streams ​

...MediaStream[]

Returns ​

RTCRtpSender

addTransceiver() ​

addTransceiver(trackOrKind, options?): RTCRtpTransceiver

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:193

Parameters ​

trackOrKind ​

MediaStreamTrack | Kind

options? ​

Partial<TransceiverOptions>

Returns ​

RTCRtpTransceiver

close() ​

close(): Promise<void>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:200

Returns ​

Promise<void>

createAnswer() ​

createAnswer(): Promise<RTCSessionDescription>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:195

Returns ​

Promise<RTCSessionDescription>

createDataChannel() ​

createDataChannel(label, options?): RTCDataChannel

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:169

Parameters ​

label ​

string

options? ​

Partial<{ id?: number; maxPacketLifeTime?: number; maxRetransmits?: number; negotiated: boolean; ordered: boolean; protocol: string; }>

Returns ​

RTCDataChannel

createOffer() ​

createOffer(__namedParameters?): Promise<RTCSessionDescription>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:165

Parameters ​

__namedParameters? ​
iceRestart? ​

boolean

Returns ​

Promise<RTCSessionDescription>

emit() ​

emit(type, ...args): boolean

Defined in: node_modules/werift/lib/webrtc/src/helper.d.ts:14

Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

Returns true if the event had listeners, false otherwise.

js
import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();

// First listener
myEmitter.on('event', function firstListener() {
  console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
  const parameters = args.join(', ');
  console.log(`event with parameters ${parameters} in third listener`);
});

console.log(myEmitter.listeners('event'));

myEmitter.emit('event', 1, 2, 3, 4, 5);

// Prints:
// [
//   [Function: firstListener],
//   [Function: secondListener],
//   [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener

Parameters ​

type ​

string | symbol

args ​

...any[]

Returns ​

boolean

Since ​

v0.1.26

Inherited from ​

EventTarget.emit

eventNames() ​

eventNames(): (string | symbol)[]

Defined in: node_modules/@types/node/events.d.ts:154

Returns an array listing the events for which the emitter has registered listeners.

js
import { EventEmitter } from 'node:events';

const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

const sym = Symbol('symbol');
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

Returns ​

(string | symbol)[]

Since ​

v6.0.0

Inherited from ​

EventTarget.eventNames

getConfiguration() ​

getConfiguration(): object

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:113

Returns ​

bundlePolicy ​

bundlePolicy: BundlePolicy

certificates ​

certificates: RTCCertificate[]

codecs ​

codecs: object

codecs.audio ​

audio: RTCRtpCodecParameters[] | undefined

codecs.video ​

video: RTCRtpCodecParameters[] | undefined

debug ​

debug: object

debug.disableRecvRetransmit? ​

optional disableRecvRetransmit?: boolean

debug.disableSendNack? ​

optional disableSendNack?: boolean

debug.inboundPacketLoss? ​

optional inboundPacketLoss?: number

debug.outboundPacketLoss? ​

optional outboundPacketLoss?: number

debug.receiverReportDelay? ​

optional receiverReportDelay?: number

dtls ​

dtls: object

dtls.keys? ​

optional keys?: DtlsKeys

forceTurnTCP ​

forceTurnTCP: boolean

Deprecated ​

Prefer turn URL transport parameters or turnTransport.

headerExtensions ​

headerExtensions: object

headerExtensions.audio ​

audio: RTCRtpHeaderExtensionParameters[] | undefined

headerExtensions.video ​

video: RTCRtpHeaderExtensionParameters[] | undefined

iceAdditionalHostAddresses ​

iceAdditionalHostAddresses: string[] | undefined

iceCandidatePoolSize ​

iceCandidatePoolSize: number

iceFilterCandidatePair ​

iceFilterCandidatePair: ((pair) => boolean) | undefined

iceFilterStunResponse ​

iceFilterStunResponse: ((message, addr, protocol) => boolean) | undefined

If provided, is called on each STUN request. Return true if a STUN response should be sent, false if it should be skipped.

iceInterfaceAddresses ​

iceInterfaceAddresses: InterfaceAddresses | undefined

iceLite ​

iceLite: boolean

Advertise local ICE lite and operate in the controlled role.

icePasswordPrefix ​

icePasswordPrefix: string | undefined

icePortRange ​

icePortRange: [number, number] | undefined

iceServers ​

iceServers: object[]

iceTransportPolicy ​

iceTransportPolicy: "all" | "relay"

iceUseIpv4 ​

iceUseIpv4: boolean

iceUseIpv6 ​

iceUseIpv6: boolean

iceUseLinkLocalAddress ​

iceUseLinkLocalAddress: boolean | undefined

such as google cloud run

iceUseTcp ​

iceUseTcp: boolean

maxMessageSize ​

maxMessageSize: number

Advertised local SCTP max-message-size in SDP. Use 0 for unlimited.

midSuffix ​

midSuffix: boolean

rtcpMuxPolicy ​

rtcpMuxPolicy: "require"

turnTlsOptions ​

turnTlsOptions: TlsConnectionOptions | undefined

turnTransport ​

turnTransport: "tcp" | "udp" | "tls" | undefined

getMaxListeners() ​

getMaxListeners(): number

Defined in: node_modules/@types/node/events.d.ts:161

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to events.defaultMaxListeners.

Returns ​

number

Since ​

v1.0.0

Inherited from ​

EventTarget.getMaxListeners

getReceivers() ​

getReceivers(): RTCRtpReceiver[]

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:111

Returns ​

RTCRtpReceiver[]

getSenders() ​

getSenders(): RTCRtpSender[]

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:110

Returns ​

RTCRtpSender[]

getStats() ​

getStats(selector?): Promise<RTCStatsReport>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:199

Parameters ​

selector? ​

MediaStreamTrack | null

Returns ​

Promise<RTCStatsReport>

getTransceivers() ​

getTransceivers(): RTCRtpTransceiver[]

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:109

Returns ​

RTCRtpTransceiver[]

listenerCount() ​

listenerCount<E>(eventName, listener?): number

Defined in: node_modules/@types/node/events.d.ts:170

Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

The name of the event being listened for

listener? ​

(...args) => void

The event handler function

Returns ​

number

Since ​

v3.2.0

Inherited from ​

EventTarget.listenerCount

listeners() ​

listeners<E>(eventName): (...args) => void[]

Defined in: node_modules/@types/node/events.d.ts:186

Returns a copy of the array of listeners for the event named eventName.

js
server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

Returns ​

(...args) => void[]

Since ​

v0.1.26

Inherited from ​

EventTarget.listeners

off() ​

off<E>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:191

Alias for emitter.removeListener().

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

listener ​

(...args) => void

Returns ​

this

Since ​

v10.0.0

Inherited from ​

EventTarget.off

on() ​

on<E>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:225

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

js
server.on('connection', (stream) => {
  console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

js
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

The name of the event.

listener ​

(...args) => void

The callback function

Returns ​

this

Since ​

v0.1.101

Inherited from ​

EventTarget.on

once() ​

once<E>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:256

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

js
server.once('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

js
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

The name of the event.

listener ​

(...args) => void

The callback function

Returns ​

this

Since ​

v0.3.0

Inherited from ​

EventTarget.once

prependListener() ​

prependListener<E>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:275

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

js
server.prependListener('connection', (stream) => {
  console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

The name of the event.

listener ​

(...args) => void

The callback function

Returns ​

this

Since ​

v6.0.0

Inherited from ​

EventTarget.prependListener

prependOnceListener() ​

prependOnceListener<E>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:292

Adds a one-time listener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

js
server.prependOnceListener('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

The name of the event.

listener ​

(...args) => void

The callback function

Returns ​

this

Since ​

v6.0.0

Inherited from ​

EventTarget.prependOnceListener

rawListeners() ​

rawListeners<E>(eventName): (...args) => void[]

Defined in: node_modules/@types/node/events.d.ts:326

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

js
import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');

// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

Returns ​

(...args) => void[]

Since ​

v9.4.0

Inherited from ​

EventTarget.rawListeners

removeAllListeners() ​

removeAllListeners<E>(eventName?): this

Defined in: node_modules/@types/node/events.d.ts:338

Removes all listeners, or those of the specified eventName.

It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

Returns a reference to the EventEmitter, so that calls can be chained.

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName? ​

string | symbol

Returns ​

this

Since ​

v0.1.26

Inherited from ​

EventTarget.removeAllListeners

removeListener() ​

removeListener<E>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:425

Removes the specified listener from the listener array for the event named eventName.

js
const callback = (stream) => {
  console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);

removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them from emit() in progress. Subsequent events behave as expected.

js
import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();

const callbackA = () => {
  console.log('A');
  myEmitter.removeListener('event', callbackB);
};

const callbackB = () => {
  console.log('B');
};

myEmitter.on('event', callbackA);

myEmitter.on('event', callbackB);

// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
//   A
//   B

// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
//   A

Because listeners are managed using an internal array, calling this will change the position indexes of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping') listener is removed:

js
import { EventEmitter } from 'node:events';
const ee = new EventEmitter();

function pong() {
  console.log('pong');
}

ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);

ee.emit('ping');
ee.emit('ping');

Returns a reference to the EventEmitter, so that calls can be chained.

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

listener ​

(...args) => void

Returns ​

this

Since ​

v0.1.26

Inherited from ​

EventTarget.removeListener

removeTrack() ​

removeTrack(sender): void

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:177

Parameters ​

sender ​

RTCRtpSender

Returns ​

void

restartIce() ​

restartIce(): void

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:191

Returns ​

void

setConfiguration() ​

setConfiguration(config): void

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:112

Parameters ​

config ​

RTCPeerConnectionConfig

Returns ​

void

setLocalDescription() ​

Call Signature ​

setLocalDescription(sessionDescription): Promise<void>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:182

Parameters ​
sessionDescription ​
type ​

"rollback"

Returns ​

Promise<void>

Call Signature ​

setLocalDescription(sessionDescription?): Promise<SessionDescription>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:185

Parameters ​
sessionDescription? ​

RTCLocalSessionDescriptionInit

Returns ​

Promise<SessionDescription>

setMaxListeners() ​

setMaxListeners(n): this

Defined in: node_modules/@types/node/events.d.ts:436

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters ​

n ​

number

Returns ​

this

Since ​

v0.3.5

Inherited from ​

EventTarget.setMaxListeners

setRemoteDescription() ​

setRemoteDescription(sessionDescription): Promise<void>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:192

Parameters ​

sessionDescription ​

RTCSessionDescriptionInit

Returns ​

Promise<void>