Skip to content

Commit

Permalink
📝 docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
smashah committed Jul 18, 2024
1 parent 92b00cc commit e8d7640
Show file tree
Hide file tree
Showing 279 changed files with 80,154 additions and 17,878 deletions.
250 changes: 88 additions & 162 deletions docs-v3/docs/api/classes/api_Client.Client.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ ___

### captureRejectionSymbol

`Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](/api/classes/structures_Collector.Collector.md#capturerejectionsymbol)
`Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](/api/classes/structures_Collector.Collector.md#capturerejectionsymbol-16)

#### Inherited from

Expand Down Expand Up @@ -296,7 +296,7 @@ ___

### errorMonitor

`Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](/api/classes/structures_Collector.Collector.md#errormonitor)
`Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](/api/classes/structures_Collector.Collector.md#errormonitor-16)

This symbol shall be used to install a listener for only monitoring `'error'`
events. Listeners installed using this symbol are called before the regular
Expand Down Expand Up @@ -567,7 +567,7 @@ ___
**cork**(): `void`

The `writable.cork()` method forces all written data to be buffered in memory.
The buffered data will be flushed when either the [uncork](/api/classes/logging_custom_transport.LogToEvTransport.md#uncork) or [end](/api/classes/logging_custom_transport.LogToEvTransport.md#end) methods are called.
The buffered data will be flushed when either the [uncork](/api/classes/logging_custom_transport.LogToEvTransport.md#uncork-16) or [end](/api/classes/logging_custom_transport.LogToEvTransport.md#end-16) methods are called.

The primary intent of `writable.cork()` is to accommodate a situation in which
several small chunks are written to the stream in rapid succession. Instead of
Expand Down Expand Up @@ -758,7 +758,7 @@ to the `Writable`. The optional `chunk` and `encoding` arguments allow one
final additional chunk of data to be written immediately before closing the
stream.

Calling the [write](/api/classes/logging_custom_transport.LogToEvTransport.md#write) method after calling [end](/api/classes/logging_custom_transport.LogToEvTransport.md#end) will raise an error.
Calling the [write](/api/classes/logging_custom_transport.LogToEvTransport.md#write-16) method after calling [end](/api/classes/logging_custom_transport.LogToEvTransport.md#end-16) will raise an error.

```js
// Write 'hello, ' and then end with 'world!'.
Expand Down Expand Up @@ -863,7 +863,7 @@ ___
**getMaxListeners**(): `number`

Returns the current max listener value for the `EventEmitter` which is either
set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](/api/classes/logging_custom_transport.LogToEvTransport.md#defaultmaxlisteners).
set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](/api/classes/logging_custom_transport.LogToEvTransport.md#defaultmaxlisteners-16).

**`Since`**

Expand Down Expand Up @@ -1795,7 +1795,7 @@ ___

**uncork**(): `void`

The `writable.uncork()` method flushes all data buffered since [cork](/api/classes/logging_custom_transport.LogToEvTransport.md#cork) was called.
The `writable.uncork()` method flushes all data buffered since [cork](/api/classes/logging_custom_transport.LogToEvTransport.md#cork-16) was called.

When using `writable.cork()` and `writable.uncork()` to manage the buffering
of writes to a stream, defer calls to `writable.uncork()` using`process.nextTick()`. Doing so allows batching of all`writable.write()` calls that occur within a given Node.js event
Expand Down Expand Up @@ -1873,7 +1873,7 @@ by default until they are piped or a `'data'` or `'readable'` event handler
is added.

If the data to be written can be generated or fetched on demand, it is
recommended to encapsulate the logic into a `Readable` and use [pipe](/api/classes/logging_custom_transport.LogToEvTransport.md#pipe). However, if calling `write()` is preferred, it is
recommended to encapsulate the logic into a `Readable` and use [pipe](/api/classes/logging_custom_transport.LogToEvTransport.md#pipe-16). However, if calling `write()` is preferred, it is
possible to respect backpressure and avoid memory issues using the `'drain'` event:

```js
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ ___

### captureRejectionSymbol

`Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](/api/classes/structures_Collector.Collector.md#capturerejectionsymbol)
`Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](/api/classes/structures_Collector.Collector.md#capturerejectionsymbol-16)

#### Inherited from

Expand Down Expand Up @@ -296,7 +296,7 @@ ___

### errorMonitor

`Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](/api/classes/structures_Collector.Collector.md#errormonitor)
`Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](/api/classes/structures_Collector.Collector.md#errormonitor-16)

This symbol shall be used to install a listener for only monitoring `'error'`
events. Listeners installed using this symbol are called before the regular
Expand Down Expand Up @@ -567,7 +567,7 @@ ___
**cork**(): `void`

The `writable.cork()` method forces all written data to be buffered in memory.
The buffered data will be flushed when either the [uncork](/api/classes/logging_custom_transport.NoOpTransport.md#uncork) or [end](/api/classes/logging_custom_transport.NoOpTransport.md#end) methods are called.
The buffered data will be flushed when either the [uncork](/api/classes/logging_custom_transport.NoOpTransport.md#uncork-16) or [end](/api/classes/logging_custom_transport.NoOpTransport.md#end-16) methods are called.

The primary intent of `writable.cork()` is to accommodate a situation in which
several small chunks are written to the stream in rapid succession. Instead of
Expand Down Expand Up @@ -758,7 +758,7 @@ to the `Writable`. The optional `chunk` and `encoding` arguments allow one
final additional chunk of data to be written immediately before closing the
stream.

Calling the [write](/api/classes/logging_custom_transport.NoOpTransport.md#write) method after calling [end](/api/classes/logging_custom_transport.NoOpTransport.md#end) will raise an error.
Calling the [write](/api/classes/logging_custom_transport.NoOpTransport.md#write-16) method after calling [end](/api/classes/logging_custom_transport.NoOpTransport.md#end-16) will raise an error.

```js
// Write 'hello, ' and then end with 'world!'.
Expand Down Expand Up @@ -863,7 +863,7 @@ ___
**getMaxListeners**(): `number`

Returns the current max listener value for the `EventEmitter` which is either
set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](/api/classes/logging_custom_transport.NoOpTransport.md#defaultmaxlisteners).
set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](/api/classes/logging_custom_transport.NoOpTransport.md#defaultmaxlisteners-16).

**`Since`**

Expand Down Expand Up @@ -1795,7 +1795,7 @@ ___

**uncork**(): `void`

The `writable.uncork()` method flushes all data buffered since [cork](/api/classes/logging_custom_transport.NoOpTransport.md#cork) was called.
The `writable.uncork()` method flushes all data buffered since [cork](/api/classes/logging_custom_transport.NoOpTransport.md#cork-16) was called.

When using `writable.cork()` and `writable.uncork()` to manage the buffering
of writes to a stream, defer calls to `writable.uncork()` using`process.nextTick()`. Doing so allows batching of all`writable.write()` calls that occur within a given Node.js event
Expand Down Expand Up @@ -1873,7 +1873,7 @@ by default until they are piped or a `'data'` or `'readable'` event handler
is added.

If the data to be written can be generated or fetched on demand, it is
recommended to encapsulate the logic into a `Readable` and use [pipe](/api/classes/logging_custom_transport.NoOpTransport.md#pipe). However, if calling `write()` is preferred, it is
recommended to encapsulate the logic into a `Readable` and use [pipe](/api/classes/logging_custom_transport.NoOpTransport.md#pipe-16). However, if calling `write()` is preferred, it is
possible to respect backpressure and avoid memory issues using the `'drain'` event:

```js
Expand Down
6 changes: 3 additions & 3 deletions docs-v3/docs/api/classes/structures_Collector.Collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ BaseCollection<K, V\>.constructor

#### Inherited from

BaseCollection.\_\_@toStringTag@814
BaseCollection.\_\_@toStringTag@18633

___

Expand Down Expand Up @@ -100,7 +100,7 @@ ___

#### Inherited from

BaseCollection.\_\_@species@2149
BaseCollection.\_\_@species@19968

## Methods

Expand All @@ -116,7 +116,7 @@ Returns an iterable of entries in the map.

#### Inherited from

BaseCollection.\_\_@iterator@47
BaseCollection.\_\_@iterator@17866

___

Expand Down
6 changes: 3 additions & 3 deletions docs-v3/docs/api/classes/structures_Collector.Collector.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ ___

### captureRejectionSymbol

`Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](/api/classes/structures_Collector.Collector.md#capturerejectionsymbol)
`Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](/api/classes/structures_Collector.Collector.md#capturerejectionsymbol-16)

#### Inherited from

Expand Down Expand Up @@ -122,7 +122,7 @@ ___

### errorMonitor

`Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](/api/classes/structures_Collector.Collector.md#errormonitor)
`Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](/api/classes/structures_Collector.Collector.md#errormonitor-16)

This symbol shall be used to install a listener for only monitoring `'error'`
events. Listeners installed using this symbol are called before the regular
Expand Down Expand Up @@ -450,7 +450,7 @@ ___
**getMaxListeners**(): `number`

Returns the current max listener value for the `EventEmitter` which is either
set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](/api/classes/structures_Collector.Collector.md#defaultmaxlisteners).
set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](/api/classes/structures_Collector.Collector.md#defaultmaxlisteners-16).

**`Since`**

Expand Down
Loading

0 comments on commit e8d7640

Please sign in to comment.