# Interface ReadableStream

interface ReadableStream {
[captureRejectionSymbol]?<K>(error: Error, event: string | symbol, ...args: AnyRest): void;
addListener<K>(eventName: string | symbol, listener: ((...args: any[]) => void)): this;
on<K>(eventName: string | symbol, listener: ((...args: any[]) => void)): this;
once<K>(eventName: string | symbol, listener: ((...args: any[]) => void)): this;
removeListener<K>(eventName: string | symbol, listener: ((...args: any[]) => void)): this;
off<K>(eventName: string | symbol, listener: ((...args: any[]) => void)): this;
removeAllListeners(event?: string | symbol): this;
setMaxListeners(n: number): this;
getMaxListeners(): number;
listeners<K>(eventName: string | symbol): Function[];
rawListeners<K>(eventName: string | symbol): Function[];
emit<K>(eventName: string | symbol, ...args: AnyRest): boolean;
listenerCount<K>(eventName: string | symbol, listener?: Function): number;
prependListener<K>(eventName: string | symbol, listener: ((...args: any[]) => void)): this;
prependOnceListener<K>(eventName: string | symbol, listener: ((...args: any[]) => void)): this;
eventNames(): (string | symbol)[];
readable: boolean;
read(size?: number): string | Buffer;
setEncoding(encoding: BufferEncoding): this;
pause(): this;
resume(): this;
isPaused(): boolean;
pipe<T>(destination: T, options?: {
end?: boolean;
}): T;
unpipe(destination?: WritableStream): this;
unshift(chunk: string | Uint8Array, encoding?: BufferEncoding): void;
wrap(oldStream: ReadableStream): this;
[asyncIterator](): AsyncIterableIterator<string | Buffer, any, any>;
}

#### Hierarchy (view full)

- EventEmitter
  - ReadableStream
    - ReadWriteStream

#### Implemented by

- Readable

- Defined in node_modules/@types/node/globals.d.ts:335

#####
Index

### Properties

readable

### Methods

[captureRejectionSymbol]?
addListener
on
once
removeListener
off
removeAllListeners
setMaxListeners
getMaxListeners
listeners
rawListeners
emit
listenerCount
prependListener
prependOnceListener
eventNames
read
setEncoding
pause
resume
isPaused
pipe
unpipe
unshift
wrap
[asyncIterator]

##
Properties

### readable

readable: boolean

- Defined in node_modules/@types/node/globals.d.ts:336

##
Methods

### `Optional`[captureRejectionSymbol]

- [captureRejectionSymbol]<K>(error, event, ...args): void

- #### Type Parameters

  - K

  #### Parameters

  - error: Error
  - event: string | symbol
  - `Rest`...args: AnyRest

  #### Returns void

  Inherited from EventEmitter.[captureRejectionSymbol]

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

### addListener

- addListener<K>(eventName, listener): this

- Alias for `emitter.on(eventName, listener)`.

  #### Type Parameters

  - K

  #### Parameters

  - eventName: string | symbol
  - listener: ((...args: any[]) => void)
    - - (...args): void

      - #### Parameters

        - `Rest`...args: any[]

        #### Returns void

  #### Returns this

  #### Since

  v0.1.26

  Inherited from EventEmitter.addListener

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

### on

- on<K>(eventName, listener): this

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

      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.

      const myEE = new EventEmitter();
      myEE.on('foo', () => console.log('a'));
      myEE.prependListener('foo', () => console.log('b'));
      myEE.emit('foo');
      // Prints:
      //   b
      //   a

  #### Type Parameters

  - K

  #### Parameters

  - eventName: string | symbol

    The name of the event.

  - listener: ((...args: any[]) => void)

    The callback function

    - - (...args): void

      - #### Parameters

        - `Rest`...args: any[]

        #### Returns void

  #### Returns this

  #### Since

  v0.1.101

  Inherited from EventEmitter.on

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

### once

- once<K>(eventName, listener): this

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

      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.

      const myEE = new EventEmitter();
      myEE.once('foo', () => console.log('a'));
      myEE.prependOnceListener('foo', () => console.log('b'));
      myEE.emit('foo');
      // Prints:
      //   b
      //   a

  #### Type Parameters

  - K

  #### Parameters

  - eventName: string | symbol

    The name of the event.

  - listener: ((...args: any[]) => void)

    The callback function

    - - (...args): void

      - #### Parameters

        - `Rest`...args: any[]

        #### Returns void

  #### Returns this

  #### Since

  v0.3.0

  Inherited from EventEmitter.once

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

### removeListener

- removeListener<K>(eventName, listener): this

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

      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.

      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 indices 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:

      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

  - K

  #### Parameters

  - eventName: string | symbol
  - listener: ((...args: any[]) => void)
    - - (...args): void

      - #### Parameters

        - `Rest`...args: any[]

        #### Returns void

  #### Returns this

  #### Since

  v0.1.26

  Inherited from EventEmitter.removeListener

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

### off

- off<K>(eventName, listener): this

- Alias for `emitter.removeListener()`.

  #### Type Parameters

  - K

  #### Parameters

  - eventName: string | symbol
  - listener: ((...args: any[]) => void)
    - - (...args): void

      - #### Parameters

        - `Rest`...args: any[]

        #### Returns void

  #### Returns this

  #### Since

  v10.0.0

  Inherited from EventEmitter.off

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

### removeAllListeners

- removeAllListeners(event?): this

- 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` event: string | symbol

  #### Returns this

  #### Since

  v0.1.26

  Inherited from EventEmitter.removeAllListeners

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

### setMaxListeners

- setMaxListeners(n): this

- By default `EventEmitter`s 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 EventEmitter.setMaxListeners

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

### getMaxListeners

- getMaxListeners(): number

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

  #### Returns number

  #### Since

  v1.0.0

  Inherited from EventEmitter.getMaxListeners

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

### listeners

- listeners<K>(eventName): Function[]

- 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

  Inherited from EventEmitter.listeners

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

### rawListeners

- rawListeners<K>(eventName): Function[]

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

      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

  Inherited from EventEmitter.rawListeners

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

### emit

- emit<K>(eventName, ...args): boolean

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

      const EventEmitter = require('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

  Inherited from EventEmitter.emit

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

### listenerCount

- listenerCount<K>(eventName, listener?): number

- Returns the number of listeners listening to 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

  Inherited from EventEmitter.listenerCount

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

### prependListener

- prependListener<K>(eventName, listener): this

- 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: any[]) => void)

    The callback function

    - - (...args): void

      - #### Parameters

        - `Rest`...args: any[]

        #### Returns void

  #### Returns this

  #### Since

  v6.0.0

  Inherited from EventEmitter.prependListener

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

### prependOnceListener

- prependOnceListener<K>(eventName, listener): this

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

      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: any[]) => void)

    The callback function

    - - (...args): void

      - #### Parameters

        - `Rest`...args: any[]

        #### Returns void

  #### Returns this

  #### Since

  v6.0.0

  Inherited from EventEmitter.prependOnceListener

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

### eventNames

- eventNames(): (string | symbol)[]

- Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or `Symbol`s.

      const EventEmitter = require('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 EventEmitter.eventNames

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

### read

- read(size?): string | Buffer

- #### Parameters

  - `Optional` size: number

  #### Returns string | Buffer

  - Defined in node_modules/@types/node/globals.d.ts:337

### setEncoding

- setEncoding(encoding): this

- #### Parameters

  - encoding: BufferEncoding

  #### Returns this

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

### pause

- pause(): this

- #### Returns this

  - Defined in node_modules/@types/node/globals.d.ts:339

### resume

- resume(): this

- #### Returns this

  - Defined in node_modules/@types/node/globals.d.ts:340

### isPaused

- isPaused(): boolean

- #### Returns boolean

  - Defined in node_modules/@types/node/globals.d.ts:341

### pipe

- pipe<T>(destination, options?): T

- #### Type Parameters

  - T extends WritableStream

  #### Parameters

  - destination: T
  - `Optional` options: {
    end?: boolean;
    }

    - ##### `Optional` end?: boolean

  #### Returns T

  - Defined in node_modules/@types/node/globals.d.ts:342

### unpipe

- unpipe(destination?): this

- #### Parameters

  - `Optional` destination: WritableStream

  #### Returns this

  - Defined in node_modules/@types/node/globals.d.ts:343

### unshift

- unshift(chunk, encoding?): void

- #### Parameters

  - chunk: string | Uint8Array
  - `Optional` encoding: BufferEncoding

  #### Returns void

  - Defined in node_modules/@types/node/globals.d.ts:344

### wrap

- wrap(oldStream): this

- #### Parameters

  - oldStream: ReadableStream

  #### Returns this

  - Defined in node_modules/@types/node/globals.d.ts:345

### [asyncIterator]

- [asyncIterator](): AsyncIterableIterator<string | Buffer, any, any>

- #### Returns AsyncIterableIterator<string | Buffer, any, any>

  - Defined in node_modules/@types/node/globals.d.ts:346