mirror of
https://github.com/chenasraf/DefinitelyTyped.git
synced 2026-05-18 01:49:01 +00:00
🤖 Merge PR #65741 [node] Update types to v20.3.0 by @Semigradsky
https://github.com/nodejs/node/releases/tag/v20.3.0 There are only doc changes
This commit is contained in:
committed by
GitHub
parent
ed5580319c
commit
9a6a0cdd49
9
types/node/buffer.d.ts
vendored
9
types/node/buffer.d.ts
vendored
@@ -299,6 +299,10 @@ declare module 'buffer' {
|
||||
* const buf = Buffer.from([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]);
|
||||
* ```
|
||||
*
|
||||
* If `array` is an `Array`\-like object (that is, one with a `length` property of
|
||||
* type `number`), it is treated as if it is an array, unless it is a `Buffer` or
|
||||
* a `Uint8Array`. This means all other `TypedArray` variants get treated as an`Array`. To create a `Buffer` from the bytes backing a `TypedArray`, use `Buffer.copyBytesFrom()`.
|
||||
*
|
||||
* A `TypeError` will be thrown if `array` is not an `Array` or another type
|
||||
* appropriate for `Buffer.from()` variants.
|
||||
*
|
||||
@@ -550,9 +554,8 @@ declare module 'buffer' {
|
||||
* A `TypeError` will be thrown if `size` is not a number.
|
||||
*
|
||||
* The `Buffer` module pre-allocates an internal `Buffer` instance of
|
||||
* size `Buffer.poolSize` that is used as a pool for the fast allocation of new`Buffer` instances created using `Buffer.allocUnsafe()`,`Buffer.from(array)`, `Buffer.concat()`, and the
|
||||
* deprecated`new Buffer(size)` constructor only when `size` is less than or equal
|
||||
* to `Buffer.poolSize >> 1` (floor of `Buffer.poolSize` divided by two).
|
||||
* size `Buffer.poolSize` that is used as a pool for the fast allocation of new`Buffer` instances created using `Buffer.allocUnsafe()`, `Buffer.from(array)`,
|
||||
* and `Buffer.concat()` only when `size` is less than or equal to`Buffer.poolSize >> 1` (floor of `Buffer.poolSize` divided by two).
|
||||
*
|
||||
* Use of this pre-allocated internal memory pool is a key difference between
|
||||
* calling `Buffer.alloc(size, fill)` vs. `Buffer.allocUnsafe(size).fill(fill)`.
|
||||
|
||||
26
types/node/crypto.d.ts
vendored
26
types/node/crypto.d.ts
vendored
@@ -21,14 +21,14 @@ declare module 'crypto' {
|
||||
import { PeerCertificate } from 'node:tls';
|
||||
/**
|
||||
* SPKAC is a Certificate Signing Request mechanism originally implemented by
|
||||
* Netscape and was specified formally as part of [HTML5's `keygen` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/keygen).
|
||||
* Netscape and was specified formally as part of HTML5's `keygen` element.
|
||||
*
|
||||
* `<keygen>` is deprecated since [HTML 5.2](https://www.w3.org/TR/html52/changes.html#features-removed) and new projects
|
||||
* should not use this element anymore.
|
||||
*
|
||||
* The `node:crypto` module provides the `Certificate` class for working with SPKAC
|
||||
* data. The most common usage is handling output generated by the HTML5`<keygen>` element. Node.js uses [OpenSSL's SPKAC
|
||||
* implementation](https://www.openssl.org/docs/man1.1.0/apps/openssl-spkac.html) internally.
|
||||
* implementation](https://www.openssl.org/docs/man3.0/man1/openssl-spkac.html) internally.
|
||||
* @since v0.11.8
|
||||
*/
|
||||
class Certificate {
|
||||
@@ -223,7 +223,9 @@ declare module 'crypto' {
|
||||
* display the available digest algorithms.
|
||||
*
|
||||
* The `key` is the HMAC key used to generate the cryptographic HMAC hash. If it is
|
||||
* a `KeyObject`, its type must be `secret`.
|
||||
* a `KeyObject`, its type must be `secret`. If it is a string, please consider `caveats when using strings as inputs to cryptographic APIs`. If it was
|
||||
* obtained from a cryptographically secure source of entropy, such as {@link randomBytes} or {@link generateKey}, its length should not
|
||||
* exceed the block size of `algorithm` (e.g., 512 bits for SHA-256).
|
||||
*
|
||||
* Example: generating the sha256 HMAC of a file
|
||||
*
|
||||
@@ -683,13 +685,13 @@ declare module 'crypto' {
|
||||
* **GCM, or CCM).**
|
||||
*
|
||||
* The implementation of `crypto.createCipher()` derives keys using the OpenSSL
|
||||
* function [`EVP_BytesToKey`](https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html) with the digest algorithm set to MD5, one
|
||||
* function [`EVP_BytesToKey`](https://www.openssl.org/docs/man3.0/man3/EVP_BytesToKey.html) with the digest algorithm set to MD5, one
|
||||
* iteration, and no salt. The lack of salt allows dictionary attacks as the same
|
||||
* password always creates the same key. The low iteration count and
|
||||
* non-cryptographically secure hash algorithm allow passwords to be tested very
|
||||
* rapidly.
|
||||
*
|
||||
* In line with OpenSSL's recommendation to use a more modern algorithm instead of [`EVP_BytesToKey`](https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html) it is recommended that
|
||||
* In line with OpenSSL's recommendation to use a more modern algorithm instead of [`EVP_BytesToKey`](https://www.openssl.org/docs/man3.0/man3/EVP_BytesToKey.html) it is recommended that
|
||||
* developers derive a key and IV on
|
||||
* their own using {@link scrypt} and to use {@link createCipheriv} to create the `Cipher` object. Users should not use ciphers with counter mode
|
||||
* (e.g. CTR, GCM, or CCM) in `crypto.createCipher()`. A warning is emitted when
|
||||
@@ -944,13 +946,13 @@ declare module 'crypto' {
|
||||
* **GCM, or CCM).**
|
||||
*
|
||||
* The implementation of `crypto.createDecipher()` derives keys using the OpenSSL
|
||||
* function [`EVP_BytesToKey`](https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html) with the digest algorithm set to MD5, one
|
||||
* function [`EVP_BytesToKey`](https://www.openssl.org/docs/man3.0/man3/EVP_BytesToKey.html) with the digest algorithm set to MD5, one
|
||||
* iteration, and no salt. The lack of salt allows dictionary attacks as the same
|
||||
* password always creates the same key. The low iteration count and
|
||||
* non-cryptographically secure hash algorithm allow passwords to be tested very
|
||||
* rapidly.
|
||||
*
|
||||
* In line with OpenSSL's recommendation to use a more modern algorithm instead of [`EVP_BytesToKey`](https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html) it is recommended that
|
||||
* In line with OpenSSL's recommendation to use a more modern algorithm instead of [`EVP_BytesToKey`](https://www.openssl.org/docs/man3.0/man3/EVP_BytesToKey.html) it is recommended that
|
||||
* developers derive a key and IV on
|
||||
* their own using {@link scrypt} and to use {@link createDecipheriv} to create the `Decipher` object.
|
||||
* @since v0.1.94
|
||||
@@ -1195,11 +1197,14 @@ declare module 'crypto' {
|
||||
* generateKey,
|
||||
* } = await import('node:crypto');
|
||||
*
|
||||
* generateKey('hmac', { length: 64 }, (err, key) => {
|
||||
* generateKey('hmac', { length: 512 }, (err, key) => {
|
||||
* if (err) throw err;
|
||||
* console.log(key.export().toString('hex')); // 46e..........620
|
||||
* });
|
||||
* ```
|
||||
*
|
||||
* The size of a generated HMAC key should not exceed the block size of the
|
||||
* underlying hash function. See {@link createHmac} for more information.
|
||||
* @since v15.0.0
|
||||
* @param type The intended use of the generated secret key. Currently accepted values are `'hmac'` and `'aes'`.
|
||||
*/
|
||||
@@ -1218,9 +1223,12 @@ declare module 'crypto' {
|
||||
* generateKeySync,
|
||||
* } = await import('node:crypto');
|
||||
*
|
||||
* const key = generateKeySync('hmac', { length: 64 });
|
||||
* const key = generateKeySync('hmac', { length: 512 });
|
||||
* console.log(key.export().toString('hex')); // e89..........41e
|
||||
* ```
|
||||
*
|
||||
* The size of a generated HMAC key should not exceed the block size of the
|
||||
* underlying hash function. See {@link createHmac} for more information.
|
||||
* @since v15.0.0
|
||||
* @param type The intended use of the generated secret key. Currently accepted values are `'hmac'` and `'aes'`.
|
||||
*/
|
||||
|
||||
9
types/node/fs.d.ts
vendored
9
types/node/fs.d.ts
vendored
@@ -1632,18 +1632,19 @@ declare module 'fs' {
|
||||
*
|
||||
* The callback is given a possible exception and, if `recursive` is `true`, the
|
||||
* first directory path created, `(err[, path])`.`path` can still be `undefined` when `recursive` is `true`, if no directory was
|
||||
* created.
|
||||
* created (for instance, if it was previously created).
|
||||
*
|
||||
* The optional `options` argument can be an integer specifying `mode` (permission
|
||||
* and sticky bits), or an object with a `mode` property and a `recursive`property indicating whether parent directories should be created. Calling`fs.mkdir()` when `path` is a directory that
|
||||
* exists results in an error only
|
||||
* when `recursive` is false.
|
||||
* when `recursive` is false. If `recursive` is false and the directory exists,
|
||||
* an `EEXIST` error occurs.
|
||||
*
|
||||
* ```js
|
||||
* import { mkdir } from 'node:fs';
|
||||
*
|
||||
* // Creates /tmp/a/apple, regardless of whether `/tmp` and /tmp/a exist.
|
||||
* mkdir('/tmp/a/apple', { recursive: true }, (err) => {
|
||||
* // Create ./tmp/a/apple, regardless of whether ./tmp and ./tmp/a exist.
|
||||
* mkdir('./tmp/a/apple', { recursive: true }, (err) => {
|
||||
* if (err) throw err;
|
||||
* });
|
||||
* ```
|
||||
|
||||
2
types/node/index.d.ts
vendored
2
types/node/index.d.ts
vendored
@@ -1,4 +1,4 @@
|
||||
// Type definitions for non-npm package Node.js 20.2
|
||||
// Type definitions for non-npm package Node.js 20.3
|
||||
// Project: https://nodejs.org/
|
||||
// Definitions by: Microsoft TypeScript <https://github.com/Microsoft>
|
||||
// DefinitelyTyped <https://github.com/DefinitelyTyped>
|
||||
|
||||
14
types/node/net.d.ts
vendored
14
types/node/net.d.ts
vendored
@@ -310,12 +310,14 @@ declare module 'net' {
|
||||
*/
|
||||
readonly remoteAddress?: string | undefined;
|
||||
/**
|
||||
* The string representation of the remote IP family. `'IPv4'` or `'IPv6'`.
|
||||
* The string representation of the remote IP family. `'IPv4'` or `'IPv6'`. Value may be `undefined` if
|
||||
* the socket is destroyed (for example, if the client disconnected).
|
||||
* @since v0.11.14
|
||||
*/
|
||||
readonly remoteFamily?: string | undefined;
|
||||
/**
|
||||
* The numeric representation of the remote port. For example, `80` or `21`.
|
||||
* The numeric representation of the remote port. For example, `80` or `21`. Value may be `undefined` if
|
||||
* the socket is destroyed (for example, if the client disconnected).
|
||||
* @since v0.5.10
|
||||
*/
|
||||
readonly remotePort?: number | undefined;
|
||||
@@ -744,8 +746,8 @@ declare module 'net' {
|
||||
*
|
||||
* Test this by using `telnet`:
|
||||
*
|
||||
* ```console
|
||||
* $ telnet localhost 8124
|
||||
* ```bash
|
||||
* telnet localhost 8124
|
||||
* ```
|
||||
*
|
||||
* To listen on the socket `/tmp/echo.sock`:
|
||||
@@ -758,8 +760,8 @@ declare module 'net' {
|
||||
*
|
||||
* Use `nc` to connect to a Unix domain socket server:
|
||||
*
|
||||
* ```console
|
||||
* $ nc -U /tmp/echo.sock
|
||||
* ```bash
|
||||
* nc -U /tmp/echo.sock
|
||||
* ```
|
||||
* @since v0.5.0
|
||||
* @param connectionListener Automatically set as a listener for the {@link 'connection'} event.
|
||||
|
||||
51
types/node/process.d.ts
vendored
51
types/node/process.d.ts
vendored
@@ -307,8 +307,8 @@ declare module 'process' {
|
||||
*
|
||||
* Launching the Node.js process as:
|
||||
*
|
||||
* ```console
|
||||
* $ node process-args.js one two=three four
|
||||
* ```bash
|
||||
* node process-args.js one two=three four
|
||||
* ```
|
||||
*
|
||||
* Would generate the output:
|
||||
@@ -344,8 +344,8 @@ declare module 'process' {
|
||||
* the script name. These options are useful in order to spawn child processes with
|
||||
* the same execution environment as the parent.
|
||||
*
|
||||
* ```console
|
||||
* $ node --harmony script.js --version
|
||||
* ```bash
|
||||
* node --harmony script.js --version
|
||||
* ```
|
||||
*
|
||||
* Results in `process.execArgv`:
|
||||
@@ -492,8 +492,8 @@ declare module 'process' {
|
||||
* to other `Worker` threads.
|
||||
* In other words, the following example would not work:
|
||||
*
|
||||
* ```console
|
||||
* $ node -e 'process.env.foo = "bar"' && echo $foo
|
||||
* ```bash
|
||||
* node -e 'process.env.foo = "bar"' && echo $foo
|
||||
* ```
|
||||
*
|
||||
* While the following will:
|
||||
@@ -898,21 +898,30 @@ declare module 'process' {
|
||||
* Will generate an object similar to:
|
||||
*
|
||||
* ```console
|
||||
* { node: '11.13.0',
|
||||
* v8: '7.0.276.38-node.18',
|
||||
* uv: '1.27.0',
|
||||
* zlib: '1.2.11',
|
||||
* brotli: '1.0.7',
|
||||
* ares: '1.15.0',
|
||||
* modules: '67',
|
||||
* nghttp2: '1.34.0',
|
||||
* napi: '4',
|
||||
* llhttp: '1.1.1',
|
||||
* openssl: '1.1.1b',
|
||||
* cldr: '34.0',
|
||||
* icu: '63.1',
|
||||
* tz: '2018e',
|
||||
* unicode: '11.0' }
|
||||
* { node: '20.2.0',
|
||||
* acorn: '8.8.2',
|
||||
* ada: '2.4.0',
|
||||
* ares: '1.19.0',
|
||||
* base64: '0.5.0',
|
||||
* brotli: '1.0.9',
|
||||
* cjs_module_lexer: '1.2.2',
|
||||
* cldr: '43.0',
|
||||
* icu: '73.1',
|
||||
* llhttp: '8.1.0',
|
||||
* modules: '115',
|
||||
* napi: '8',
|
||||
* nghttp2: '1.52.0',
|
||||
* nghttp3: '0.7.0',
|
||||
* ngtcp2: '0.8.1',
|
||||
* openssl: '3.0.8+quic',
|
||||
* simdutf: '3.2.9',
|
||||
* tz: '2023c',
|
||||
* undici: '5.22.0',
|
||||
* unicode: '15.0',
|
||||
* uv: '1.44.2',
|
||||
* uvwasi: '0.0.16',
|
||||
* v8: '11.3.244.8-node.9',
|
||||
* zlib: '1.2.13' }
|
||||
* ```
|
||||
* @since v0.2.0
|
||||
*/
|
||||
|
||||
9
types/node/ts4.8/buffer.d.ts
vendored
9
types/node/ts4.8/buffer.d.ts
vendored
@@ -299,6 +299,10 @@ declare module 'buffer' {
|
||||
* const buf = Buffer.from([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]);
|
||||
* ```
|
||||
*
|
||||
* If `array` is an `Array`\-like object (that is, one with a `length` property of
|
||||
* type `number`), it is treated as if it is an array, unless it is a `Buffer` or
|
||||
* a `Uint8Array`. This means all other `TypedArray` variants get treated as an`Array`. To create a `Buffer` from the bytes backing a `TypedArray`, use `Buffer.copyBytesFrom()`.
|
||||
*
|
||||
* A `TypeError` will be thrown if `array` is not an `Array` or another type
|
||||
* appropriate for `Buffer.from()` variants.
|
||||
*
|
||||
@@ -550,9 +554,8 @@ declare module 'buffer' {
|
||||
* A `TypeError` will be thrown if `size` is not a number.
|
||||
*
|
||||
* The `Buffer` module pre-allocates an internal `Buffer` instance of
|
||||
* size `Buffer.poolSize` that is used as a pool for the fast allocation of new`Buffer` instances created using `Buffer.allocUnsafe()`,`Buffer.from(array)`, `Buffer.concat()`, and the
|
||||
* deprecated`new Buffer(size)` constructor only when `size` is less than or equal
|
||||
* to `Buffer.poolSize >> 1` (floor of `Buffer.poolSize` divided by two).
|
||||
* size `Buffer.poolSize` that is used as a pool for the fast allocation of new`Buffer` instances created using `Buffer.allocUnsafe()`, `Buffer.from(array)`,
|
||||
* and `Buffer.concat()` only when `size` is less than or equal to`Buffer.poolSize >> 1` (floor of `Buffer.poolSize` divided by two).
|
||||
*
|
||||
* Use of this pre-allocated internal memory pool is a key difference between
|
||||
* calling `Buffer.alloc(size, fill)` vs. `Buffer.allocUnsafe(size).fill(fill)`.
|
||||
|
||||
26
types/node/ts4.8/crypto.d.ts
vendored
26
types/node/ts4.8/crypto.d.ts
vendored
@@ -21,14 +21,14 @@ declare module 'crypto' {
|
||||
import { PeerCertificate } from 'node:tls';
|
||||
/**
|
||||
* SPKAC is a Certificate Signing Request mechanism originally implemented by
|
||||
* Netscape and was specified formally as part of [HTML5's `keygen` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/keygen).
|
||||
* Netscape and was specified formally as part of HTML5's `keygen` element.
|
||||
*
|
||||
* `<keygen>` is deprecated since [HTML 5.2](https://www.w3.org/TR/html52/changes.html#features-removed) and new projects
|
||||
* should not use this element anymore.
|
||||
*
|
||||
* The `node:crypto` module provides the `Certificate` class for working with SPKAC
|
||||
* data. The most common usage is handling output generated by the HTML5`<keygen>` element. Node.js uses [OpenSSL's SPKAC
|
||||
* implementation](https://www.openssl.org/docs/man1.1.0/apps/openssl-spkac.html) internally.
|
||||
* implementation](https://www.openssl.org/docs/man3.0/man1/openssl-spkac.html) internally.
|
||||
* @since v0.11.8
|
||||
*/
|
||||
class Certificate {
|
||||
@@ -223,7 +223,9 @@ declare module 'crypto' {
|
||||
* display the available digest algorithms.
|
||||
*
|
||||
* The `key` is the HMAC key used to generate the cryptographic HMAC hash. If it is
|
||||
* a `KeyObject`, its type must be `secret`.
|
||||
* a `KeyObject`, its type must be `secret`. If it is a string, please consider `caveats when using strings as inputs to cryptographic APIs`. If it was
|
||||
* obtained from a cryptographically secure source of entropy, such as {@link randomBytes} or {@link generateKey}, its length should not
|
||||
* exceed the block size of `algorithm` (e.g., 512 bits for SHA-256).
|
||||
*
|
||||
* Example: generating the sha256 HMAC of a file
|
||||
*
|
||||
@@ -683,13 +685,13 @@ declare module 'crypto' {
|
||||
* **GCM, or CCM).**
|
||||
*
|
||||
* The implementation of `crypto.createCipher()` derives keys using the OpenSSL
|
||||
* function [`EVP_BytesToKey`](https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html) with the digest algorithm set to MD5, one
|
||||
* function [`EVP_BytesToKey`](https://www.openssl.org/docs/man3.0/man3/EVP_BytesToKey.html) with the digest algorithm set to MD5, one
|
||||
* iteration, and no salt. The lack of salt allows dictionary attacks as the same
|
||||
* password always creates the same key. The low iteration count and
|
||||
* non-cryptographically secure hash algorithm allow passwords to be tested very
|
||||
* rapidly.
|
||||
*
|
||||
* In line with OpenSSL's recommendation to use a more modern algorithm instead of [`EVP_BytesToKey`](https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html) it is recommended that
|
||||
* In line with OpenSSL's recommendation to use a more modern algorithm instead of [`EVP_BytesToKey`](https://www.openssl.org/docs/man3.0/man3/EVP_BytesToKey.html) it is recommended that
|
||||
* developers derive a key and IV on
|
||||
* their own using {@link scrypt} and to use {@link createCipheriv} to create the `Cipher` object. Users should not use ciphers with counter mode
|
||||
* (e.g. CTR, GCM, or CCM) in `crypto.createCipher()`. A warning is emitted when
|
||||
@@ -944,13 +946,13 @@ declare module 'crypto' {
|
||||
* **GCM, or CCM).**
|
||||
*
|
||||
* The implementation of `crypto.createDecipher()` derives keys using the OpenSSL
|
||||
* function [`EVP_BytesToKey`](https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html) with the digest algorithm set to MD5, one
|
||||
* function [`EVP_BytesToKey`](https://www.openssl.org/docs/man3.0/man3/EVP_BytesToKey.html) with the digest algorithm set to MD5, one
|
||||
* iteration, and no salt. The lack of salt allows dictionary attacks as the same
|
||||
* password always creates the same key. The low iteration count and
|
||||
* non-cryptographically secure hash algorithm allow passwords to be tested very
|
||||
* rapidly.
|
||||
*
|
||||
* In line with OpenSSL's recommendation to use a more modern algorithm instead of [`EVP_BytesToKey`](https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html) it is recommended that
|
||||
* In line with OpenSSL's recommendation to use a more modern algorithm instead of [`EVP_BytesToKey`](https://www.openssl.org/docs/man3.0/man3/EVP_BytesToKey.html) it is recommended that
|
||||
* developers derive a key and IV on
|
||||
* their own using {@link scrypt} and to use {@link createDecipheriv} to create the `Decipher` object.
|
||||
* @since v0.1.94
|
||||
@@ -1195,11 +1197,14 @@ declare module 'crypto' {
|
||||
* generateKey,
|
||||
* } = await import('node:crypto');
|
||||
*
|
||||
* generateKey('hmac', { length: 64 }, (err, key) => {
|
||||
* generateKey('hmac', { length: 512 }, (err, key) => {
|
||||
* if (err) throw err;
|
||||
* console.log(key.export().toString('hex')); // 46e..........620
|
||||
* });
|
||||
* ```
|
||||
*
|
||||
* The size of a generated HMAC key should not exceed the block size of the
|
||||
* underlying hash function. See {@link createHmac} for more information.
|
||||
* @since v15.0.0
|
||||
* @param type The intended use of the generated secret key. Currently accepted values are `'hmac'` and `'aes'`.
|
||||
*/
|
||||
@@ -1218,9 +1223,12 @@ declare module 'crypto' {
|
||||
* generateKeySync,
|
||||
* } = await import('node:crypto');
|
||||
*
|
||||
* const key = generateKeySync('hmac', { length: 64 });
|
||||
* const key = generateKeySync('hmac', { length: 512 });
|
||||
* console.log(key.export().toString('hex')); // e89..........41e
|
||||
* ```
|
||||
*
|
||||
* The size of a generated HMAC key should not exceed the block size of the
|
||||
* underlying hash function. See {@link createHmac} for more information.
|
||||
* @since v15.0.0
|
||||
* @param type The intended use of the generated secret key. Currently accepted values are `'hmac'` and `'aes'`.
|
||||
*/
|
||||
|
||||
9
types/node/ts4.8/fs.d.ts
vendored
9
types/node/ts4.8/fs.d.ts
vendored
@@ -1632,18 +1632,19 @@ declare module 'fs' {
|
||||
*
|
||||
* The callback is given a possible exception and, if `recursive` is `true`, the
|
||||
* first directory path created, `(err[, path])`.`path` can still be `undefined` when `recursive` is `true`, if no directory was
|
||||
* created.
|
||||
* created (for instance, if it was previously created).
|
||||
*
|
||||
* The optional `options` argument can be an integer specifying `mode` (permission
|
||||
* and sticky bits), or an object with a `mode` property and a `recursive`property indicating whether parent directories should be created. Calling`fs.mkdir()` when `path` is a directory that
|
||||
* exists results in an error only
|
||||
* when `recursive` is false.
|
||||
* when `recursive` is false. If `recursive` is false and the directory exists,
|
||||
* an `EEXIST` error occurs.
|
||||
*
|
||||
* ```js
|
||||
* import { mkdir } from 'node:fs';
|
||||
*
|
||||
* // Creates /tmp/a/apple, regardless of whether `/tmp` and /tmp/a exist.
|
||||
* mkdir('/tmp/a/apple', { recursive: true }, (err) => {
|
||||
* // Create ./tmp/a/apple, regardless of whether ./tmp and ./tmp/a exist.
|
||||
* mkdir('./tmp/a/apple', { recursive: true }, (err) => {
|
||||
* if (err) throw err;
|
||||
* });
|
||||
* ```
|
||||
|
||||
14
types/node/ts4.8/net.d.ts
vendored
14
types/node/ts4.8/net.d.ts
vendored
@@ -310,12 +310,14 @@ declare module 'net' {
|
||||
*/
|
||||
readonly remoteAddress?: string | undefined;
|
||||
/**
|
||||
* The string representation of the remote IP family. `'IPv4'` or `'IPv6'`.
|
||||
* The string representation of the remote IP family. `'IPv4'` or `'IPv6'`. Value may be `undefined` if
|
||||
* the socket is destroyed (for example, if the client disconnected).
|
||||
* @since v0.11.14
|
||||
*/
|
||||
readonly remoteFamily?: string | undefined;
|
||||
/**
|
||||
* The numeric representation of the remote port. For example, `80` or `21`.
|
||||
* The numeric representation of the remote port. For example, `80` or `21`. Value may be `undefined` if
|
||||
* the socket is destroyed (for example, if the client disconnected).
|
||||
* @since v0.5.10
|
||||
*/
|
||||
readonly remotePort?: number | undefined;
|
||||
@@ -744,8 +746,8 @@ declare module 'net' {
|
||||
*
|
||||
* Test this by using `telnet`:
|
||||
*
|
||||
* ```console
|
||||
* $ telnet localhost 8124
|
||||
* ```bash
|
||||
* telnet localhost 8124
|
||||
* ```
|
||||
*
|
||||
* To listen on the socket `/tmp/echo.sock`:
|
||||
@@ -758,8 +760,8 @@ declare module 'net' {
|
||||
*
|
||||
* Use `nc` to connect to a Unix domain socket server:
|
||||
*
|
||||
* ```console
|
||||
* $ nc -U /tmp/echo.sock
|
||||
* ```bash
|
||||
* nc -U /tmp/echo.sock
|
||||
* ```
|
||||
* @since v0.5.0
|
||||
* @param connectionListener Automatically set as a listener for the {@link 'connection'} event.
|
||||
|
||||
51
types/node/ts4.8/process.d.ts
vendored
51
types/node/ts4.8/process.d.ts
vendored
@@ -307,8 +307,8 @@ declare module 'process' {
|
||||
*
|
||||
* Launching the Node.js process as:
|
||||
*
|
||||
* ```console
|
||||
* $ node process-args.js one two=three four
|
||||
* ```bash
|
||||
* node process-args.js one two=three four
|
||||
* ```
|
||||
*
|
||||
* Would generate the output:
|
||||
@@ -344,8 +344,8 @@ declare module 'process' {
|
||||
* the script name. These options are useful in order to spawn child processes with
|
||||
* the same execution environment as the parent.
|
||||
*
|
||||
* ```console
|
||||
* $ node --harmony script.js --version
|
||||
* ```bash
|
||||
* node --harmony script.js --version
|
||||
* ```
|
||||
*
|
||||
* Results in `process.execArgv`:
|
||||
@@ -492,8 +492,8 @@ declare module 'process' {
|
||||
* to other `Worker` threads.
|
||||
* In other words, the following example would not work:
|
||||
*
|
||||
* ```console
|
||||
* $ node -e 'process.env.foo = "bar"' && echo $foo
|
||||
* ```bash
|
||||
* node -e 'process.env.foo = "bar"' && echo $foo
|
||||
* ```
|
||||
*
|
||||
* While the following will:
|
||||
@@ -898,21 +898,30 @@ declare module 'process' {
|
||||
* Will generate an object similar to:
|
||||
*
|
||||
* ```console
|
||||
* { node: '11.13.0',
|
||||
* v8: '7.0.276.38-node.18',
|
||||
* uv: '1.27.0',
|
||||
* zlib: '1.2.11',
|
||||
* brotli: '1.0.7',
|
||||
* ares: '1.15.0',
|
||||
* modules: '67',
|
||||
* nghttp2: '1.34.0',
|
||||
* napi: '4',
|
||||
* llhttp: '1.1.1',
|
||||
* openssl: '1.1.1b',
|
||||
* cldr: '34.0',
|
||||
* icu: '63.1',
|
||||
* tz: '2018e',
|
||||
* unicode: '11.0' }
|
||||
* { node: '20.2.0',
|
||||
* acorn: '8.8.2',
|
||||
* ada: '2.4.0',
|
||||
* ares: '1.19.0',
|
||||
* base64: '0.5.0',
|
||||
* brotli: '1.0.9',
|
||||
* cjs_module_lexer: '1.2.2',
|
||||
* cldr: '43.0',
|
||||
* icu: '73.1',
|
||||
* llhttp: '8.1.0',
|
||||
* modules: '115',
|
||||
* napi: '8',
|
||||
* nghttp2: '1.52.0',
|
||||
* nghttp3: '0.7.0',
|
||||
* ngtcp2: '0.8.1',
|
||||
* openssl: '3.0.8+quic',
|
||||
* simdutf: '3.2.9',
|
||||
* tz: '2023c',
|
||||
* undici: '5.22.0',
|
||||
* unicode: '15.0',
|
||||
* uv: '1.44.2',
|
||||
* uvwasi: '0.0.16',
|
||||
* v8: '11.3.244.8-node.9',
|
||||
* zlib: '1.2.13' }
|
||||
* ```
|
||||
* @since v0.2.0
|
||||
*/
|
||||
|
||||
5
types/node/ts4.8/tty.d.ts
vendored
5
types/node/ts4.8/tty.d.ts
vendored
@@ -42,7 +42,10 @@ declare module 'tty' {
|
||||
constructor(fd: number, options?: net.SocketConstructorOpts);
|
||||
/**
|
||||
* A `boolean` that is `true` if the TTY is currently configured to operate as a
|
||||
* raw device. Defaults to `false`.
|
||||
* raw device.
|
||||
*
|
||||
* This flag is always `false` when a process starts, even if the terminal is
|
||||
* operating in raw mode. Its value will change with subsequent calls to`setRawMode`.
|
||||
* @since v0.7.7
|
||||
*/
|
||||
isRaw: boolean;
|
||||
|
||||
4
types/node/ts4.8/wasi.d.ts
vendored
4
types/node/ts4.8/wasi.d.ts
vendored
@@ -58,8 +58,8 @@
|
||||
*
|
||||
* Use [wabt](https://github.com/WebAssembly/wabt) to compile `.wat` to `.wasm`
|
||||
*
|
||||
* ```console
|
||||
* $ wat2wasm demo.wat
|
||||
* ```bash
|
||||
* wat2wasm demo.wat
|
||||
* ```
|
||||
* @experimental
|
||||
* @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/wasi.js)
|
||||
|
||||
5
types/node/tty.d.ts
vendored
5
types/node/tty.d.ts
vendored
@@ -42,7 +42,10 @@ declare module 'tty' {
|
||||
constructor(fd: number, options?: net.SocketConstructorOpts);
|
||||
/**
|
||||
* A `boolean` that is `true` if the TTY is currently configured to operate as a
|
||||
* raw device. Defaults to `false`.
|
||||
* raw device.
|
||||
*
|
||||
* This flag is always `false` when a process starts, even if the terminal is
|
||||
* operating in raw mode. Its value will change with subsequent calls to`setRawMode`.
|
||||
* @since v0.7.7
|
||||
*/
|
||||
isRaw: boolean;
|
||||
|
||||
4
types/node/wasi.d.ts
vendored
4
types/node/wasi.d.ts
vendored
@@ -58,8 +58,8 @@
|
||||
*
|
||||
* Use [wabt](https://github.com/WebAssembly/wabt) to compile `.wat` to `.wasm`
|
||||
*
|
||||
* ```console
|
||||
* $ wat2wasm demo.wat
|
||||
* ```bash
|
||||
* wat2wasm demo.wat
|
||||
* ```
|
||||
* @experimental
|
||||
* @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/wasi.js)
|
||||
|
||||
Reference in New Issue
Block a user