@types/node 15.6.2 → 15.12.2

node/stream.d.ts

@@ -301,7 +301,7 @@ declare module 'stream' {
          */
         function addAbortSignal<T extends Stream>(signal: AbortSignal, stream: T): T;
 
-        interface FinishedOptions {
+        interface FinishedOptions extends Abortable {
             error?: boolean;
             readable?: boolean;
             writable?: boolean;

node/timers/promises.d.ts

@@ -3,11 +3,19 @@ declare module 'timers/promises' {
 
     /**
      * Returns a promise that resolves after the specified delay in milliseconds.
+     * @param delay defaults to 1
      */
-    function setTimeout<T>(delay: number, value?: T, options?: TimerOptions): Promise<T>;
+    function setTimeout<T = void>(delay?: number, value?: T, options?: TimerOptions): Promise<T>;
 
     /**
      * Returns a promise that resolves in the next tick.
      */
-    function setImmediate<T>(value: T, options?: TimerOptions): Promise<T>;
+    function setImmediate<T = void>(value?: T, options?: TimerOptions): Promise<T>;
+
+    /**
+     *
+     * Returns an async iterator that generates values in an interval of delay ms.
+     * @param delay defaults to 1
+     */
+    function setInterval<T = void>(delay?: number, value?: T, options?: TimerOptions): AsyncIterable<T>;
 }

node/timers.d.ts

@@ -1,16 +1,13 @@
 declare module 'timers' {
-    interface TimerOptions {
+    import { Abortable } from 'events';
+
+    interface TimerOptions extends Abortable {
         /**
          * Set to `false` to indicate that the scheduled `Timeout`
          * should not require the Node.js event loop to remain active.
          * @default true
          */
         ref?: boolean;
-
-        /**
-         * An optional `AbortSignal` that can be used to cancel the scheduled `Timeout`.
-         */
-        signal?: AbortSignal;
     }
 
     function setTimeout(callback: (...args: any[]) => void, ms?: number, ...args: any[]): NodeJS.Timeout;

node/tls.d.ts

@@ -1,4 +1,5 @@
 declare module 'tls' {
+    import { X509Certificate } from 'crypto';
     import * as net from 'net';
 
     const CLIENT_RENEG_LIMIT: number;
@@ -295,6 +296,16 @@ declare module 'tls' {
          */
         enableTrace(): void;
 
+        /**
+         * If there is no peer certificate, or the socket has been destroyed, `undefined` will be returned.
+         */
+        getPeerX509Certificate(): X509Certificate | undefined;
+
+        /**
+         * If there is no local certificate, or the socket has been destroyed, `undefined` will be returned.
+         */
+        getX509Certificate(): X509Certificate | undefined;
+
         /**
          * @param length number of bytes to retrieve from keying material
          * @param label an application specific label, typically this will be a value from the

node/ts3.6/base.d.ts

@@ -3,8 +3,8 @@
 // NOTE: TypeScript version-specific augmentations can be found in the following paths:
 //          - ~/base.d.ts         - Shared definitions common to all TypeScript versions
 //          - ~/index.d.ts        - Definitions specific to TypeScript 3.7 and above
-//          - ~/ts3.5/base.d.ts   - Definitions specific to TypeScript 3.6 and earlier
-//          - ~/ts3.5/index.d.ts  - Definitions specific to TypeScript 3.6 and earlier with assert pulled in
+//          - ~/ts3.6/base.d.ts   - Definitions specific to TypeScript 3.6 and earlier
+//          - ~/ts3.6/index.d.ts  - Definitions specific to TypeScript 3.6 and earlier with assert pulled in
 
 // Reference required types from the default lib:
 /// <reference lib="es2018" />
@@ -61,8 +61,8 @@
 /// <reference path="../worker_threads.d.ts" />
 /// <reference path="../zlib.d.ts" />
 
-// TypeScript 3.5-specific augmentations:
+// TypeScript 3.6-specific augmentations:
 /// <reference path="../globals.global.d.ts" />
 
-// TypeScript 3.5-specific augmentations:
+// TypeScript 3.6-specific augmentations:
 /// <reference path="../wasi.d.ts" />

node/ts3.6/index.d.ts

@@ -1,4 +1,4 @@
-// NOTE: These definitions support NodeJS and TypeScript 3.5 - 3.6.
+// NOTE: These definitions support NodeJS and TypeScript 3.6.
 // This is required to enable typing assert in ts3.7 without causing errors
 // Typically type modifications should be made in base.d.ts instead of here
 

node/wasi.d.ts

@@ -58,7 +58,7 @@ declare module 'wasi' {
          * invoke the `__wasi_unstable_reactor_start()` export. If neither of those exports
          * is present on `instance`, then `start()` does nothing.
          *
-         * `start()` requires that `instance` exports a [`WebAssembly.Memory`][] named
+         * `start()` requires that `instance` exports a `WebAssembly.Memory` named
          * `memory`. If `instance` does not have a `memory` export an exception is thrown.
          *
          * If `start()` is called more than once, an exception is thrown.
@@ -69,7 +69,7 @@ declare module 'wasi' {
          * Attempt to initialize `instance` as a WASI reactor by invoking its `_initialize()` export, if it is present.
          * If `instance` contains a `_start()` export, then an exception is thrown.
          *
-         * `start()` requires that `instance` exports a [`WebAssembly.Memory`][] named
+         * `start()` requires that `instance` exports a `WebAssembly.Memory` named
          * `memory`. If `instance` does not have a `memory` export an exception is thrown.
          *
          * If `initialize()` is called more than once, an exception is thrown.
@@ -79,7 +79,7 @@ declare module 'wasi' {
         /**
          * Is an object that implements the WASI system call API. This object
          * should be passed as the `wasi_snapshot_preview1` import during the instantiation of a
-         * [`WebAssembly.Instance`][].
+         * `WebAssembly.Instance`.
          */
         readonly wasiImport: NodeJS.Dict<any>; // TODO: Narrow to DOM types
     }

node/worker_threads.d.ts

@@ -1,4 +1,5 @@
 declare module 'worker_threads' {
+    import { Blob } from 'node:buffer';
     import { Context } from 'vm';
     import { EventEmitter } from 'events';
     import { EventLoopUtilityFunction } from 'perf_hooks';
@@ -23,7 +24,7 @@ declare module 'worker_threads' {
         eventLoopUtilization: EventLoopUtilityFunction;
     }
 
-    type TransferListItem = ArrayBuffer | MessagePort | FileHandle | X509Certificate;
+    type TransferListItem = ArrayBuffer | MessagePort | FileHandle | X509Certificate | Blob;
 
     class MessagePort extends EventEmitter {
         close(): void;
@@ -145,11 +146,11 @@ declare module 'worker_threads' {
 
         /**
          * Returns a readable stream for a V8 snapshot of the current state of the Worker.
-         * See [`v8.getHeapSnapshot()`][] for more details.
+         * See `v8.getHeapSnapshot()` for more details.
          *
          * If the Worker thread is no longer running, which may occur before the
-         * [`'exit'` event][] is emitted, the returned `Promise` will be rejected
-         * immediately with an [`ERR_WORKER_NOT_RUNNING`][] error
+         * `'exit'` event is emitted, the returned `Promise` will be rejected
+         * immediately with an `ERR_WORKER_NOT_RUNNING` error
          */
         getHeapSnapshot(): Promise<Readable>;
 
@@ -261,4 +262,21 @@ declare module 'worker_threads' {
      * `MessagePort`’s queue.
      */
     function receiveMessageOnPort(port: MessagePort): { message: any } | undefined;
+
+    type Serializable = string | object | number | boolean | bigint;
+
+    /**
+     * @param key Any arbitrary, cloneable JavaScript value that can be used as a {Map} key.
+     * @experimental
+     */
+    function getEnvironmentData(key: Serializable): Serializable;
+
+    /**
+     * @param key Any arbitrary, cloneable JavaScript value that can be used as a {Map} key.
+     * @param value Any arbitrary, cloneable JavaScript value that will be cloned
+     * and passed automatically to all new `Worker` instances. If `value` is passed
+     * as `undefined`, any previously set value for the `key` will be deleted.
+     * @experimental
+     */
+    function setEnvironmentData(key: Serializable, value: Serializable): void;
 }