chore(docs): Generated JS Client Reference (#5334)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
378ca1b36e
commit
daea35fe73
@@ -0,0 +1,906 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Interface: ReadableStream
|
||||
|
||||
[internal](../modules/internal-8.md).ReadableStream
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- [`EventEmitter`](internal-8.EventEmitter-2.md)
|
||||
|
||||
↳ **`ReadableStream`**
|
||||
|
||||
↳↳ [`ReadWriteStream`](internal-8.ReadWriteStream.md)
|
||||
|
||||
## Implemented by
|
||||
|
||||
- [`ReadableBase`](../classes/internal-8.ReadableBase.md)
|
||||
|
||||
## Properties
|
||||
|
||||
### readable
|
||||
|
||||
• **readable**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/globals.d.ts:210
|
||||
|
||||
## Methods
|
||||
|
||||
### [asyncIterator]
|
||||
|
||||
▸ **[asyncIterator]**(): [`AsyncIterableIterator`](internal-8.AsyncIterableIterator.md)<`string` \| [`Buffer`](../modules/internal-8.md#buffer)\>
|
||||
|
||||
#### Returns
|
||||
|
||||
[`AsyncIterableIterator`](internal-8.AsyncIterableIterator.md)<`string` \| [`Buffer`](../modules/internal-8.md#buffer)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/globals.d.ts:220
|
||||
|
||||
___
|
||||
|
||||
### addListener
|
||||
|
||||
▸ **addListener**(`eventName`, `listener`): [`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
Alias for `emitter.on(eventName, listener)`.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `eventName` | `string` \| `symbol` |
|
||||
| `listener` | (...`args`: `any`[]) => `void` |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
**`Since`**
|
||||
|
||||
v0.1.26
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[EventEmitter](internal-8.EventEmitter-2.md).[addListener](internal-8.EventEmitter-2.md#addlistener)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/events.d.ts:390
|
||||
|
||||
___
|
||||
|
||||
### emit
|
||||
|
||||
▸ **emit**(`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.
|
||||
|
||||
```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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `eventName` | `string` \| `symbol` |
|
||||
| `...args` | `any`[] |
|
||||
|
||||
#### Returns
|
||||
|
||||
`boolean`
|
||||
|
||||
**`Since`**
|
||||
|
||||
v0.1.26
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[EventEmitter](internal-8.EventEmitter-2.md).[emit](internal-8.EventEmitter-2.md#emit)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/events.d.ts:652
|
||||
|
||||
___
|
||||
|
||||
### 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.
|
||||
|
||||
```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
|
||||
|
||||
[EventEmitter](internal-8.EventEmitter-2.md).[eventNames](internal-8.EventEmitter-2.md#eventnames)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/events.d.ts:715
|
||||
|
||||
___
|
||||
|
||||
### 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](internal-8.EventEmitter-2.md).[getMaxListeners](internal-8.EventEmitter-2.md#getmaxlisteners)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/events.d.ts:567
|
||||
|
||||
___
|
||||
|
||||
### isPaused
|
||||
|
||||
▸ **isPaused**(): `boolean`
|
||||
|
||||
#### Returns
|
||||
|
||||
`boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/globals.d.ts:215
|
||||
|
||||
___
|
||||
|
||||
### listenerCount
|
||||
|
||||
▸ **listenerCount**(`eventName`, `listener?`): `number`
|
||||
|
||||
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.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `eventName` | `string` \| `symbol` | The name of the event being listened for |
|
||||
| `listener?` | `Function` | The event handler function |
|
||||
|
||||
#### Returns
|
||||
|
||||
`number`
|
||||
|
||||
**`Since`**
|
||||
|
||||
v3.2.0
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[EventEmitter](internal-8.EventEmitter-2.md).[listenerCount](internal-8.EventEmitter-2.md#listenercount)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/events.d.ts:661
|
||||
|
||||
___
|
||||
|
||||
### listeners
|
||||
|
||||
▸ **listeners**(`eventName`): `Function`[]
|
||||
|
||||
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] ]
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `eventName` | `string` \| `symbol` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Function`[]
|
||||
|
||||
**`Since`**
|
||||
|
||||
v0.1.26
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[EventEmitter](internal-8.EventEmitter-2.md).[listeners](internal-8.EventEmitter-2.md#listeners)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/events.d.ts:580
|
||||
|
||||
___
|
||||
|
||||
### off
|
||||
|
||||
▸ **off**(`eventName`, `listener`): [`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
Alias for `emitter.removeListener()`.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `eventName` | `string` \| `symbol` |
|
||||
| `listener` | (...`args`: `any`[]) => `void` |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
**`Since`**
|
||||
|
||||
v10.0.0
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[EventEmitter](internal-8.EventEmitter-2.md).[off](internal-8.EventEmitter-2.md#off)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/events.d.ts:540
|
||||
|
||||
___
|
||||
|
||||
### on
|
||||
|
||||
▸ **on**(`eventName`, `listener`): [`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
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
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `eventName` | `string` \| `symbol` | The name of the event. |
|
||||
| `listener` | (...`args`: `any`[]) => `void` | The callback function |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
**`Since`**
|
||||
|
||||
v0.1.101
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[EventEmitter](internal-8.EventEmitter-2.md).[on](internal-8.EventEmitter-2.md#on)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/events.d.ts:422
|
||||
|
||||
___
|
||||
|
||||
### once
|
||||
|
||||
▸ **once**(`eventName`, `listener`): [`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
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
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `eventName` | `string` \| `symbol` | The name of the event. |
|
||||
| `listener` | (...`args`: `any`[]) => `void` | The callback function |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
**`Since`**
|
||||
|
||||
v0.3.0
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[EventEmitter](internal-8.EventEmitter-2.md).[once](internal-8.EventEmitter-2.md#once)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/events.d.ts:452
|
||||
|
||||
___
|
||||
|
||||
### pause
|
||||
|
||||
▸ **pause**(): [`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/globals.d.ts:213
|
||||
|
||||
___
|
||||
|
||||
### pipe
|
||||
|
||||
▸ **pipe**<`T`\>(`destination`, `options?`): `T`
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | extends [`WritableStream`](internal-8.WritableStream.md) |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `destination` | `T` |
|
||||
| `options?` | `Object` |
|
||||
| `options.end?` | `boolean` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`T`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/globals.d.ts:216
|
||||
|
||||
___
|
||||
|
||||
### prependListener
|
||||
|
||||
▸ **prependListener**(`eventName`, `listener`): [`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
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.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `eventName` | `string` \| `symbol` | The name of the event. |
|
||||
| `listener` | (...`args`: `any`[]) => `void` | The callback function |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
**`Since`**
|
||||
|
||||
v6.0.0
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[EventEmitter](internal-8.EventEmitter-2.md).[prependListener](internal-8.EventEmitter-2.md#prependlistener)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/events.d.ts:679
|
||||
|
||||
___
|
||||
|
||||
### prependOnceListener
|
||||
|
||||
▸ **prependOnceListener**(`eventName`, `listener`): [`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
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.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `eventName` | `string` \| `symbol` | The name of the event. |
|
||||
| `listener` | (...`args`: `any`[]) => `void` | The callback function |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
**`Since`**
|
||||
|
||||
v6.0.0
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[EventEmitter](internal-8.EventEmitter-2.md).[prependOnceListener](internal-8.EventEmitter-2.md#prependoncelistener)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/events.d.ts:695
|
||||
|
||||
___
|
||||
|
||||
### rawListeners
|
||||
|
||||
▸ **rawListeners**(`eventName`): `Function`[]
|
||||
|
||||
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');
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `eventName` | `string` \| `symbol` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Function`[]
|
||||
|
||||
**`Since`**
|
||||
|
||||
v9.4.0
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[EventEmitter](internal-8.EventEmitter-2.md).[rawListeners](internal-8.EventEmitter-2.md#rawlisteners)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/events.d.ts:611
|
||||
|
||||
___
|
||||
|
||||
### read
|
||||
|
||||
▸ **read**(`size?`): `string` \| [`Buffer`](../modules/internal-8.md#buffer)
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `size?` | `number` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`string` \| [`Buffer`](../modules/internal-8.md#buffer)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/globals.d.ts:211
|
||||
|
||||
___
|
||||
|
||||
### removeAllListeners
|
||||
|
||||
▸ **removeAllListeners**(`event?`): [`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `event?` | `string` \| `symbol` |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
**`Since`**
|
||||
|
||||
v0.1.26
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[EventEmitter](internal-8.EventEmitter-2.md).[removeAllListeners](internal-8.EventEmitter-2.md#removealllisteners)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/events.d.ts:551
|
||||
|
||||
___
|
||||
|
||||
### removeListener
|
||||
|
||||
▸ **removeListener**(`eventName`, `listener`): [`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
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 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:
|
||||
|
||||
```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.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `eventName` | `string` \| `symbol` |
|
||||
| `listener` | (...`args`: `any`[]) => `void` |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
**`Since`**
|
||||
|
||||
v0.1.26
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[EventEmitter](internal-8.EventEmitter-2.md).[removeListener](internal-8.EventEmitter-2.md#removelistener)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/events.d.ts:535
|
||||
|
||||
___
|
||||
|
||||
### resume
|
||||
|
||||
▸ **resume**(): [`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/globals.d.ts:214
|
||||
|
||||
___
|
||||
|
||||
### setEncoding
|
||||
|
||||
▸ **setEncoding**(`encoding`): [`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/globals.d.ts:212
|
||||
|
||||
___
|
||||
|
||||
### setMaxListeners
|
||||
|
||||
▸ **setMaxListeners**(`n`): [`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `n` | `number` |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
**`Since`**
|
||||
|
||||
v0.3.5
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[EventEmitter](internal-8.EventEmitter-2.md).[setMaxListeners](internal-8.EventEmitter-2.md#setmaxlisteners)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/events.d.ts:561
|
||||
|
||||
___
|
||||
|
||||
### unpipe
|
||||
|
||||
▸ **unpipe**(`destination?`): [`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `destination?` | [`WritableStream`](internal-8.WritableStream.md) |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/globals.d.ts:217
|
||||
|
||||
___
|
||||
|
||||
### unshift
|
||||
|
||||
▸ **unshift**(`chunk`, `encoding?`): `void`
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `chunk` | `string` \| `Uint8Array` |
|
||||
| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) |
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/globals.d.ts:218
|
||||
|
||||
___
|
||||
|
||||
### wrap
|
||||
|
||||
▸ **wrap**(`oldStream`): [`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `oldStream` | [`ReadableStream`](internal-8.ReadableStream.md) |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ReadableStream`](internal-8.ReadableStream.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa-js/node_modules/@types/node/globals.d.ts:219
|
||||
Reference in New Issue
Block a user