Skip to content

Commit 0e1361c

Browse files
ronagMylesBorins
authored andcommitted
net: doc deprecate bufferSize
PR-URL: #34088 Refs: #34078 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
1 parent b7e9b43 commit 0e1361c

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

doc/api/deprecations.md

+15
Original file line numberDiff line numberDiff line change
@@ -2707,6 +2707,19 @@ Type: Runtime
27072707
`Transform._transformState` will be removed in future versions where it is
27082708
no longer required due to simplification of the implementation.
27092709

2710+
<a id="DEP0XXX"></a>
2711+
### DEP0XXX: `socket.bufferSize`
2712+
<!-- YAML
2713+
changes:
2714+
- version: REPLACEME
2715+
pr-url: https://github.com/nodejs/node/pull/REPLACEME
2716+
description: Documentation-only deprecation.
2717+
-->
2718+
2719+
Type: Documentation-only
2720+
2721+
[`socket.bufferSize`][] is just an alias for [`writable.writableLength`][].
2722+
27102723
[`--pending-deprecation`]: cli.html#cli_pending_deprecation
27112724
[`--throw-deprecation`]: cli.html#cli_throw_deprecation
27122725
[`Buffer.allocUnsafeSlow(size)`]: buffer.html#buffer_class_method_buffer_allocunsafeslow_size
@@ -2781,6 +2794,7 @@ no longer required due to simplification of the implementation.
27812794
[`script.createCachedData()`]: vm.html#vm_script_createcacheddata
27822795
[`setInterval()`]: timers.html#timers_setinterval_callback_delay_args
27832796
[`setTimeout()`]: timers.html#timers_settimeout_callback_delay_args
2797+
[`socket.bufferSize`]: net.html#net_socket_buffersize
27842798
[`timeout.ref()`]: timers.html#timers_timeout_ref
27852799
[`timeout.refresh()`]: timers.html#timers_timeout_refresh
27862800
[`timeout.unref()`]: timers.html#timers_timeout_unref
@@ -2817,6 +2831,7 @@ no longer required due to simplification of the implementation.
28172831
[`util`]: util.html
28182832
[`worker.exitedAfterDisconnect`]: cluster.html#cluster_worker_exitedafterdisconnect
28192833
[`worker.terminate()`]: worker_threads.html#worker_threads_worker_terminate
2834+
[`writable.writableLength`]: stream.html#stream_writable_writablelength
28202835
[`zlib.bytesWritten`]: zlib.html#zlib_zlib_byteswritten
28212836
[Legacy URL API]: url.html#url_legacy_url_api
28222837
[NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf

doc/api/net.md

+5
Original file line numberDiff line numberDiff line change
@@ -545,8 +545,12 @@ socket as reported by the operating system:
545545
### `socket.bufferSize`
546546
<!-- YAML
547547
added: v0.3.8
548+
deprecated:
549+
- REPLACEME
548550
-->
549551

552+
> Stability: 0 - Deprecated: Use [`writable.writableLength`][] instead.
553+
550554
* {integer}
551555

552556
This property shows the number of characters buffered for writing. The buffer
@@ -1276,6 +1280,7 @@ Returns `true` if input is a version 6 IP address, otherwise returns `false`.
12761280
[`socket.setEncoding()`]: #net_socket_setencoding_encoding
12771281
[`socket.setTimeout()`]: #net_socket_settimeout_timeout_callback
12781282
[`socket.setTimeout(timeout)`]: #net_socket_settimeout_timeout_callback
1283+
[`writable.writableLength`]: stream.html#stream_writable_writablelength
12791284
[`writable.destroyed`]: stream.html#stream_writable_destroyed
12801285
[`writable.destroy()`]: stream.html#stream_writable_destroy_error
12811286
[`writable.end()`]: stream.html#stream_writable_end_chunk_encoding_callback

0 commit comments

Comments
 (0)