diff options
| author | Nitzan Uziely <linkgoron@gmail.com> | 2021-03-13 02:13:36 +0300 |
|---|---|---|
| committer | James M Snell <jasnell@gmail.com> | 2021-04-01 22:40:49 +0300 |
| commit | f87c4d126d0d6b6f59936adc0a7aaadc435f8908 (patch) | |
| tree | 571947bce888a56a476d43b84c6153891e706f7a /doc/api/net.md | |
| parent | 7fb2a59441ebe2fb48fe1743fd21481d19a3b06b (diff) | |
net,tls: add abort signal support to connect
Add documentation for net.connect AbortSignal,
and add the support to tls.connect as well
PR-URL: https://github.com/nodejs/node/pull/37735
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/net.md')
| -rw-r--r-- | doc/api/net.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/api/net.md b/doc/api/net.md index 231dde85428..50ea9ab6c45 100644 --- a/doc/api/net.md +++ b/doc/api/net.md @@ -496,6 +496,10 @@ it to interact with the client. ### `new net.Socket([options])` <!-- YAML added: v0.3.4 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/37735 + description: AbortSignal support was added. --> * `options` {Object} Available options are: @@ -508,6 +512,8 @@ added: v0.3.4 otherwise ignored. **Default:** `false`. * `writable` {boolean} Allow writes on the socket when an `fd` is passed, otherwise ignored. **Default:** `false`. + * `signal` {AbortSignal} An Abort signal that may be used to destroy the + socket. * Returns: {net.Socket} Creates a new socket object. |