@types/node 16.4.6 → 16.4.7

node/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for Node.js (http://nodejs.org/).
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node.
 
 ### Additional Details
- * Last updated: Wed, 28 Jul 2021 19:31:18 GMT
+ * Last updated: Thu, 29 Jul 2021 13:01:18 GMT
  * Dependencies: none
  * Global values: `AbortController`, `AbortSignal`, `__dirname`, `__filename`, `console`, `exports`, `gc`, `global`, `module`, `process`, `require`
 

node/assert.d.ts

@@ -12,8 +12,6 @@ declare module 'assert' {
     function assert(value: unknown, message?: string | Error): asserts value;
     namespace assert {
         /**
-         * * Extends: `<errors.Error>`
-         *
          * Indicates the failure of an assertion. All errors thrown by the `assert` module
          * will be instances of the `AssertionError` class.
          */

node/crypto.d.ts

@@ -320,8 +320,6 @@ declare module 'crypto' {
     type Encoding = BinaryToTextEncoding | CharacterEncoding | LegacyCharacterEncoding;
     type ECDHKeyFormat = 'compressed' | 'uncompressed' | 'hybrid';
     /**
-     * * Extends: `<stream.Transform>`
-     *
      * The `Hash` class is a utility for creating hash digests of data. It can be
      * used in one of two ways:
      *
@@ -518,8 +516,6 @@ declare module 'crypto' {
         digest(encoding: BinaryToTextEncoding): string;
     }
     /**
-     * * Extends: `<stream.Transform>`
-     *
      * The `Hmac` class is a utility for creating cryptographic HMAC digests. It can
      * be used in one of two ways:
      *
@@ -878,8 +874,6 @@ declare module 'crypto' {
     function createCipheriv(algorithm: CipherGCMTypes, key: CipherKey, iv: BinaryLike | null, options?: CipherGCMOptions): CipherGCM;
     function createCipheriv(algorithm: string, key: CipherKey, iv: BinaryLike | null, options?: stream.TransformOptions): Cipher;
     /**
-     * * Extends: `<stream.Transform>`
-     *
      * Instances of the `Cipher` class are used to encrypt data. The class can be
      * used in one of two ways:
      *
@@ -1219,8 +1213,6 @@ declare module 'crypto' {
     function createDecipheriv(algorithm: CipherGCMTypes, key: CipherKey, iv: BinaryLike | null, options?: CipherGCMOptions): DecipherGCM;
     function createDecipheriv(algorithm: string, key: CipherKey, iv: BinaryLike | null, options?: stream.TransformOptions): Decipher;
     /**
-     * * Extends: `<stream.Transform>`
-     *
      * Instances of the `Decipher` class are used to decrypt data. The class can be
      * used in one of two ways:
      *
@@ -1584,8 +1576,6 @@ declare module 'crypto' {
     }
     type KeyLike = string | Buffer | KeyObject;
     /**
-     * * Extends: `<stream.Writable>`
-     *
      * The `Sign` class is a utility for generating signatures. It can be used in one
      * of two ways:
      *
@@ -1738,8 +1728,6 @@ declare module 'crypto' {
      */
     function createVerify(algorithm: string, options?: stream.WritableOptions): Verify;
     /**
-     * * Extends: `<stream.Writable>`
-     *
      * The `Verify` class is a utility for verifying signatures. It can be used in one
      * of two ways:
      *

node/fs.d.ts

@@ -305,8 +305,6 @@ declare module 'fs' {
         prependOnceListener(event: 'close', listener: () => void): this;
     }
     /**
-     * * Extends: `<stream.Readable>`
-     *
      * Instances of `<fs.ReadStream>` are created and returned using the {@link createReadStream} function.
      * @since v0.1.93
      */

node/http.d.ts

@@ -182,7 +182,6 @@ declare module 'http' {
     }
     interface Server extends HttpBase {}
     /**
-     * * Extends: `<net.Server>`
      * @since v0.1.17
      */
     class Server extends NetServer {
@@ -620,8 +619,6 @@ declare module 'http' {
         prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this;
     }
     /**
-     * * Extends: `<stream.Readable>`
-     *
      * An `IncomingMessage` object is created by {@link Server} or {@link ClientRequest} and passed as the first argument to the `'request'` and `'response'` event respectively. It may be used to
      * access response
      * status, headers and data.
@@ -677,7 +674,7 @@ declare module 'http' {
         /**
          * Alias for `message.socket`.
          * @since v0.1.90
-         * @deprecated Since v16.0.0 - Deprecated. Use `socket`.
+         * @deprecated Since v16.0.0 - Use `socket`.
          */
         connection: Socket;
         /**

node/http2.d.ts

@@ -1170,8 +1170,6 @@ declare module 'http2' {
         prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this;
     }
     /**
-     * * Extends: `<stream.Readable>`
-     *
      * A `Http2ServerRequest` object is created by {@link Server} or {@link SecureServer} and passed as the first argument to the `'request'` event. It may be used to access a request status,
      * headers, and
      * data.
@@ -1194,7 +1192,7 @@ declare module 'http2' {
         /**
          * See `request.socket`.
          * @since v8.4.0
-         * @deprecated Since v13.0.0 - Deprecated. Use `socket`.
+         * @deprecated Since v13.0.0 - Use `socket`.
          */
         readonly connection: net.Socket | tls.TLSSocket;
         /**
@@ -1417,14 +1415,14 @@ declare module 'http2' {
         /**
          * See `response.socket`.
          * @since v8.4.0
-         * @deprecated Since v13.0.0 - Deprecated. Use `socket`.
+         * @deprecated Since v13.0.0 - Use `socket`.
          */
         readonly connection: net.Socket | tls.TLSSocket;
         /**
          * Boolean value that indicates whether the response has completed. Starts
          * as `false`. After `response.end()` executes, the value will be `true`.
          * @since v8.4.0
-         * @deprecated Since v13.4.0,v12.16.0 - Deprecated. Use `writableEnded`.
+         * @deprecated Since v13.4.0,v12.16.0 - Use `writableEnded`.
          */
         readonly finished: boolean;
         /**
@@ -1437,10 +1435,66 @@ declare module 'http2' {
          * @since v15.7.0
          */
         readonly req: Http2ServerRequest;
+        /**
+         * Returns a `Proxy` object that acts as a `net.Socket` (or `tls.TLSSocket`) but
+         * applies getters, setters, and methods based on HTTP/2 logic.
+         *
+         * `destroyed`, `readable`, and `writable` properties will be retrieved from and
+         * set on `response.stream`.
+         *
+         * `destroy`, `emit`, `end`, `on` and `once` methods will be called on`response.stream`.
+         *
+         * `setTimeout` method will be called on `response.stream.session`.
+         *
+         * `pause`, `read`, `resume`, and `write` will throw an error with code`ERR_HTTP2_NO_SOCKET_MANIPULATION`. See `Http2Session and Sockets` for
+         * more information.
+         *
+         * All other interactions will be routed directly to the socket.
+         *
+         * ```js
+         * const http2 = require('http2');
+         * const server = http2.createServer((req, res) => {
+         *   const ip = req.socket.remoteAddress;
+         *   const port = req.socket.remotePort;
+         *   res.end(`Your IP address is ${ip} and your source port is ${port}.`);
+         * }).listen(3000);
+         * ```
+         * @since v8.4.0
+         */
         readonly socket: net.Socket | tls.TLSSocket;
+        /**
+         * The `Http2Stream` object backing the response.
+         * @since v8.4.0
+         */
         readonly stream: ServerHttp2Stream;
+        /**
+         * When true, the Date header will be automatically generated and sent in
+         * the response if it is not already present in the headers. Defaults to true.
+         *
+         * This should only be disabled for testing; HTTP requires the Date header
+         * in responses.
+         * @since v8.4.0
+         */
         sendDate: boolean;
+        /**
+         * When using implicit headers (not calling `response.writeHead()` explicitly),
+         * this property controls the status code that will be sent to the client when
+         * the headers get flushed.
+         *
+         * ```js
+         * response.statusCode = 404;
+         * ```
+         *
+         * After response header was sent to the client, this property indicates the
+         * status code which was sent out.
+         * @since v8.4.0
+         */
         statusCode: number;
+        /**
+         * Status message is not supported by HTTP/2 (RFC 7540 8.1.2.4). It returns
+         * an empty string.
+         * @since v8.4.0
+         */
         statusMessage: '';
         /**
          * This method adds HTTP trailing headers (a header but at the end of the

node/https.d.ts

@@ -27,8 +27,6 @@ declare module 'https' {
     }
     interface Server extends http.HttpBase {}
     /**
-     * * Extends: `<tls.Server>`
-     *
      * See `http.Server` for more information.
      * @since v0.3.4
      */

node/module.d.ts

@@ -66,6 +66,9 @@ declare module 'module' {
          * @since v13.7.0, v12.17.0
          */
         class SourceMap {
+            /**
+             * Getter for the payload used to construct the `SourceMap` instance.
+             */
             readonly payload: SourceMapPayload;
             constructor(payload: SourceMapPayload);
             /**

node/net.d.ts

@@ -59,8 +59,6 @@ declare module 'net' {
     }
     type SocketConnectOpts = TcpSocketConnectOpts | IpcSocketConnectOpts;
     /**
-     * * Extends: `<stream.Duplex>`
-     *
      * This class is an abstraction of a TCP socket or a streaming `IPC` endpoint
      * (uses named pipes on Windows, and Unix domain sockets otherwise). It is also
      * an `EventEmitter`.

node/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/node",
-    "version": "16.4.6",
+    "version": "16.4.7",
     "description": "TypeScript definitions for Node.js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node",
     "license": "MIT",
@@ -232,6 +232,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "409fea0ec0757dc100114c6d35fe3b616cdf1e1095e08f5e2f83bd9336035435",
+    "typesPublisherContentHash": "15db94446f7f1e160948be1b1ecb14684eef4f4a29dc0fd41a570f2f071209d1",
     "typeScriptVersion": "3.6"
 }

node/process.d.ts

@@ -1165,8 +1165,8 @@ declare module 'process' {
                  * `process.umask()` returns the Node.js process's file mode creation mask. Child
                  * processes inherit the mask from the parent process.
                  * @since v0.1.19
-                 * @deprecated Deprecated. Calling `process.umask()` with no argument causes the process-wide umask to be written twice. This introduces a race condition between threads, and is a   *
-                 * potential security vulnerability. There is no safe, cross-platform alternative API.
+                 * @deprecated Calling `process.umask()` with no argument causes the process-wide umask to be written twice. This introduces a race condition between threads, and is a potential   *
+                 * security vulnerability. There is no safe, cross-platform alternative API.
                  */
                 umask(): number;
                 /**

node/tls.d.ts

@@ -127,8 +127,6 @@ declare module 'tls' {
         requestOCSP?: boolean | undefined;
     }
     /**
-     * * Extends: `<net.Socket>`
-     *
      * Performs transparent encryption of written data and all required TLS
      * negotiation.
      *
@@ -144,7 +142,9 @@ declare module 'tls' {
          */
         constructor(socket: net.Socket, options?: TLSSocketOptions);
         /**
-         * A boolean that is true if the peer certificate was signed by one of the specified CAs, otherwise false.
+         * Returns `true` if the peer certificate was signed by one of the CAs specified
+         * when creating the `tls.TLSSocket` instance, otherwise `false`.
+         * @since v0.11.4
          */
         authorized: boolean;
         /**
@@ -542,8 +542,6 @@ declare module 'tls' {
         pskCallback?(hint: string | null): PSKCallbackNegotation | null;
     }
     /**
-     * * Extends: `<net.Server>`
-     *
      * Accepts encrypted connections using TLS or SSL.
      * @since v0.3.2
      */

node/tty.d.ts

@@ -35,8 +35,6 @@ declare module 'tty' {
      */
     function isatty(fd: number): boolean;
     /**
-     * * Extends: `<net.Socket>`
-     *
      * Represents the readable side of a TTY. In normal circumstances `process.stdin` will be the only `tty.ReadStream` instance in a Node.js
      * process and there should be no reason to create additional instances.
      * @since v0.5.8
@@ -74,8 +72,6 @@ declare module 'tty' {
      */
     type Direction = -1 | 0 | 1;
     /**
-     * * Extends: `<net.Socket>`
-     *
      * Represents the writable side of a TTY. In normal circumstances,`process.stdout` and `process.stderr` will be the only`tty.WriteStream` instances created for a Node.js process and there
      * should be no reason to create additional instances.
      * @since v0.5.8