⚠️ Internal: This API is not publically exported by the package.
      interface WebSocket {
          CLOSED: 3;
          CLOSING: 2;
          CONNECTING: 0;
          OPEN: 1;
          binaryType: "nodebuffer" | "arraybuffer" | "fragments";
          bufferedAmount: number;
          extensions: string;
          isPaused: boolean;
          onclose: ((event) => void);
          onerror: ((event) => void);
          onmessage: ((event) => void);
          onopen: ((event) => void);
          protocol: string;
          readyState: 0 | 1 | 2 | 3;
          url: string;
          [captureRejectionSymbol]?<K>(error, event, ...args): void;
          addEventListener<K>(type, listener, options?): void;
          addListener(event, listener): WebSocket.WebSocket;
          addListener(event, listener): WebSocket.WebSocket;
          addListener(event, listener): WebSocket.WebSocket;
          addListener(event, listener): WebSocket.WebSocket;
          addListener(event, listener): WebSocket.WebSocket;
          addListener(event, listener): WebSocket.WebSocket;
          addListener(event, listener): WebSocket.WebSocket;
          addListener(event, listener): WebSocket.WebSocket;
          close(code?, data?): void;
          emit<K>(eventName, ...args): boolean;
          eventNames(): (string | symbol)[];
          getMaxListeners(): number;
          listenerCount<K>(eventName, listener?): number;
          listeners<K>(eventName): Function[];
          off(event, listener): WebSocket.WebSocket;
          off(event, listener): WebSocket.WebSocket;
          off(event, listener): WebSocket.WebSocket;
          off(event, listener): WebSocket.WebSocket;
          off(event, listener): WebSocket.WebSocket;
          off(event, listener): WebSocket.WebSocket;
          off(event, listener): WebSocket.WebSocket;
          off(event, listener): WebSocket.WebSocket;
          on(event, listener): WebSocket.WebSocket;
          on(event, listener): WebSocket.WebSocket;
          on(event, listener): WebSocket.WebSocket;
          on(event, listener): WebSocket.WebSocket;
          on(event, listener): WebSocket.WebSocket;
          on(event, listener): WebSocket.WebSocket;
          on(event, listener): WebSocket.WebSocket;
          on(event, listener): WebSocket.WebSocket;
          once(event, listener): WebSocket.WebSocket;
          once(event, listener): WebSocket.WebSocket;
          once(event, listener): WebSocket.WebSocket;
          once(event, listener): WebSocket.WebSocket;
          once(event, listener): WebSocket.WebSocket;
          once(event, listener): WebSocket.WebSocket;
          once(event, listener): WebSocket.WebSocket;
          once(event, listener): WebSocket.WebSocket;
          pause(): void;
          ping(data?, mask?, cb?): void;
          pong(data?, mask?, cb?): void;
          prependListener<K>(eventName, listener): WebSocket.WebSocket;
          prependOnceListener<K>(eventName, listener): WebSocket.WebSocket;
          rawListeners<K>(eventName): Function[];
          removeAllListeners(eventName?): WebSocket.WebSocket;
          removeEventListener<K>(type, listener): void;
          removeListener(event, listener): WebSocket.WebSocket;
          removeListener(event, listener): WebSocket.WebSocket;
          removeListener(event, listener): WebSocket.WebSocket;
          removeListener(event, listener): WebSocket.WebSocket;
          removeListener(event, listener): WebSocket.WebSocket;
          removeListener(event, listener): WebSocket.WebSocket;
          removeListener(event, listener): WebSocket.WebSocket;
          removeListener(event, listener): WebSocket.WebSocket;
          resume(): void;
          send(data, cb?): void;
          send(data, options, cb?): void;
          setMaxListeners(n): WebSocket.WebSocket;
          terminate(): void;
      }

      Hierarchy

      Methods

      • Type Parameters

        • K

        Parameters

        Returns void

      • Type Parameters

        Parameters

        Returns void

      • Parameters

        • event: "close"
        • listener: ((code, reason) => void)
            • (code, reason): void
            • Parameters

              • code: number
              • reason: Buffer

              Returns void

        Returns WebSocket.WebSocket

      • Parameters

        • event: "error"
        • listener: ((err) => void)
            • (err): void
            • Parameters

              Returns void

        Returns WebSocket.WebSocket

      • Parameters

        • event: "upgrade"
        • listener: ((request) => void)

        Returns WebSocket.WebSocket

      • Parameters

        • event: "message"
        • listener: ((data, isBinary) => void)
            • (data, isBinary): void
            • Parameters

              Returns void

        Returns WebSocket.WebSocket

      • Parameters

        • event: "open"
        • listener: (() => void)
            • (): void
            • Returns void

        Returns WebSocket.WebSocket

      • Parameters

        • event: "ping" | "pong"
        • listener: ((data) => void)
            • (data): void
            • Parameters

              • data: Buffer

              Returns void

        Returns WebSocket.WebSocket

      • Parameters

        • event: "unexpected-response"
        • listener: ((request, response) => void)

        Returns WebSocket.WebSocket

      • Parameters

        • event: string | symbol
        • listener: ((...args) => void)
            • (...args): void
            • Parameters

              • Rest ...args: any[]

              Returns void

        Returns WebSocket.WebSocket

      • Parameters

        • Optional code: number
        • Optional data: string | Buffer

        Returns void

      • 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.

        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

        Type Parameters

        • K

        Parameters

        • eventName: string | symbol
        • Rest ...args: AnyRest

        Returns boolean

        Since

        v0.1.26

      • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

        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

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

        Returns number

        Since

        v1.0.0

      • 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

        • K

        Parameters

        • eventName: string | symbol

          The name of the event being listened for

        • Optional listener: Function

          The event handler function

        Returns number

        Since

        v3.2.0

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

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

        Type Parameters

        • K

        Parameters

        • eventName: string | symbol

        Returns Function[]

        Since

        v0.1.26

      • Pause the websocket causing it to stop emitting events. Some events can still be emitted after this is called, until all buffered data is consumed. This method is a noop if the ready state is CONNECTING or CLOSED.

        Returns void

      • Parameters

        • Optional data: any
        • Optional mask: boolean
        • Optional cb: ((err) => void)
            • (err): void
            • Parameters

              Returns void

        Returns void

      • Parameters

        • Optional data: any
        • Optional mask: boolean
        • Optional cb: ((err) => void)
            • (err): void
            • Parameters

              Returns void

        Returns void

      • 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.

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

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

        Type Parameters

        • K

        Parameters

        • eventName: string | symbol

          The name of the event.

        • listener: ((...args) => void)

          The callback function

            • (...args): void
            • Parameters

              • Rest ...args: any[]

              Returns void

        Returns WebSocket.WebSocket

        Since

        v6.0.0

      • Adds a one-timelistener 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.

        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

        • K

        Parameters

        • eventName: string | symbol

          The name of the event.

        • listener: ((...args) => void)

          The callback function

            • (...args): void
            • Parameters

              • Rest ...args: any[]

              Returns void

        Returns WebSocket.WebSocket

        Since

        v6.0.0

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

        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

        • K

        Parameters

        • eventName: string | symbol

        Returns Function[]

        Since

        v9.4.0

      • 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.

        Parameters

        • Optional eventName: string | symbol

        Returns WebSocket.WebSocket

        Since

        v0.1.26

      • Type Parameters

        Parameters

        • type: K
        • listener: ((event) => void)

        Returns void

      • Parameters

        • event: "close"
        • listener: ((code, reason) => void)
            • (code, reason): void
            • Parameters

              • code: number
              • reason: Buffer

              Returns void

        Returns WebSocket.WebSocket

      • Parameters

        • event: "error"
        • listener: ((err) => void)
            • (err): void
            • Parameters

              Returns void

        Returns WebSocket.WebSocket

      • Parameters

        • event: "upgrade"
        • listener: ((request) => void)

        Returns WebSocket.WebSocket

      • Parameters

        • event: "message"
        • listener: ((data, isBinary) => void)
            • (data, isBinary): void
            • Parameters

              Returns void

        Returns WebSocket.WebSocket

      • Parameters

        • event: "open"
        • listener: (() => void)
            • (): void
            • Returns void

        Returns WebSocket.WebSocket

      • Parameters

        • event: "ping" | "pong"
        • listener: ((data) => void)
            • (data): void
            • Parameters

              • data: Buffer

              Returns void

        Returns WebSocket.WebSocket

      • Parameters

        • event: "unexpected-response"
        • listener: ((request, response) => void)

        Returns WebSocket.WebSocket

      • Parameters

        • event: string | symbol
        • listener: ((...args) => void)
            • (...args): void
            • Parameters

              • Rest ...args: any[]

              Returns void

        Returns WebSocket.WebSocket

      • Make a paused socket resume emitting events. This method is a noop if the ready state is CONNECTING or CLOSED.

        Returns void

      • Parameters

        • data: BufferLike
        • Optional cb: ((err?) => void)
            • (err?): void
            • Parameters

              Returns void

        Returns void

      • Parameters

        • data: BufferLike
        • options: {
              binary?: boolean;
              compress?: boolean;
              fin?: boolean;
              mask?: boolean;
          }
          • Optional binary?: boolean
          • Optional compress?: boolean
          • Optional fin?: boolean
          • Optional mask?: boolean
        • Optional cb: ((err?) => void)
            • (err?): void
            • Parameters

              Returns void

        Returns void

      • 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 WebSocket.WebSocket

        Since

        v0.3.5

      • Returns void

      Properties

      CLOSED: 3

      The connection is closed.

      CLOSING: 2

      The connection is in the process of closing.

      CONNECTING: 0

      The connection is not yet open.

      OPEN: 1

      The connection is open and ready to communicate.

      binaryType: "nodebuffer" | "arraybuffer" | "fragments"
      bufferedAmount: number
      extensions: string
      isPaused: boolean

      Indicates whether the websocket is paused

      onclose: ((event) => void)

      Type declaration

        • (event): void
        • Parameters

          Returns void

      onerror: ((event) => void)

      Type declaration

        • (event): void
        • Parameters

          Returns void

      onmessage: ((event) => void)

      Type declaration

      onopen: ((event) => void)

      Type declaration

        • (event): void
        • Parameters

          Returns void

      protocol: string
      readyState: 0 | 1 | 2 | 3

      The current state of the connection

      url: string