@types/node 16.18.70 → 16.18.72

node v16.18/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for node (https://nodejs.org/).
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node/v16.
 
 ### Additional Details
- * Last updated: Sun, 07 Jan 2024 15:35:36 GMT
+ * Last updated: Fri, 19 Jan 2024 10:07:16 GMT
  * Dependencies: none
 
 # Credits

node v16.18/dom-events.d.ts

@@ -0,0 +1,122 @@
+export {}; // Don't export anything!
+
+//// DOM-like Events
+// NB: The Event / EventTarget / EventListener implementations below were copied
+// from lib.dom.d.ts, then edited to reflect Node's documentation at
+// https://nodejs.org/api/events.html#class-eventtarget.
+// Please read that link to understand important implementation differences.
+
+// This conditional type will be the existing global Event in a browser, or
+// the copy below in a Node environment.
+type __Event = typeof globalThis extends { onmessage: any; Event: any } ? {}
+    : {
+        /** This is not used in Node.js and is provided purely for completeness. */
+        readonly bubbles: boolean;
+        /** Alias for event.stopPropagation(). This is not used in Node.js and is provided purely for completeness. */
+        cancelBubble: () => void;
+        /** True if the event was created with the cancelable option */
+        readonly cancelable: boolean;
+        /** This is not used in Node.js and is provided purely for completeness. */
+        readonly composed: boolean;
+        /** Returns an array containing the current EventTarget as the only entry or empty if the event is not being dispatched. This is not used in Node.js and is provided purely for completeness. */
+        composedPath(): [EventTarget?];
+        /** Alias for event.target. */
+        readonly currentTarget: EventTarget | null;
+        /** Is true if cancelable is true and event.preventDefault() has been called. */
+        readonly defaultPrevented: boolean;
+        /** This is not used in Node.js and is provided purely for completeness. */
+        readonly eventPhase: 0 | 2;
+        /** The `AbortSignal` "abort" event is emitted with `isTrusted` set to `true`. The value is `false` in all other cases. */
+        readonly isTrusted: boolean;
+        /** Sets the `defaultPrevented` property to `true` if `cancelable` is `true`. */
+        preventDefault(): void;
+        /** This is not used in Node.js and is provided purely for completeness. */
+        returnValue: boolean;
+        /** Alias for event.target. */
+        readonly srcElement: EventTarget | null;
+        /** Stops the invocation of event listeners after the current one completes. */
+        stopImmediatePropagation(): void;
+        /** This is not used in Node.js and is provided purely for completeness. */
+        stopPropagation(): void;
+        /** The `EventTarget` dispatching the event */
+        readonly target: EventTarget | null;
+        /** The millisecond timestamp when the Event object was created. */
+        readonly timeStamp: number;
+        /** Returns the type of event, e.g. "click", "hashchange", or "submit". */
+        readonly type: string;
+    };
+
+// See comment above explaining conditional type
+type __EventTarget = typeof globalThis extends { onmessage: any; EventTarget: any } ? {}
+    : {
+        /**
+         * Adds a new handler for the `type` event. Any given `listener` is added only once per `type` and per `capture` option value.
+         *
+         * If the `once` option is true, the `listener` is removed after the next time a `type` event is dispatched.
+         *
+         * The `capture` option is not used by Node.js in any functional way other than tracking registered event listeners per the `EventTarget` specification.
+         * Specifically, the `capture` option is used as part of the key when registering a `listener`.
+         * Any individual `listener` may be added once with `capture = false`, and once with `capture = true`.
+         */
+        addEventListener(
+            type: string,
+            listener: EventListener | EventListenerObject,
+            options?: AddEventListenerOptions | boolean,
+        ): void;
+        /** Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise. */
+        dispatchEvent(event: Event): boolean;
+        /** Removes the event listener in target's event listener list with the same type, callback, and options. */
+        removeEventListener(
+            type: string,
+            listener: EventListener | EventListenerObject,
+            options?: EventListenerOptions | boolean,
+        ): void;
+    };
+
+interface EventInit {
+    bubbles?: boolean;
+    cancelable?: boolean;
+    composed?: boolean;
+}
+
+interface EventListenerOptions {
+    /** Not directly used by Node.js. Added for API completeness. Default: `false`. */
+    capture?: boolean;
+}
+
+interface AddEventListenerOptions extends EventListenerOptions {
+    /** When `true`, the listener is automatically removed when it is first invoked. Default: `false`. */
+    once?: boolean;
+    /** When `true`, serves as a hint that the listener will not call the `Event` object's `preventDefault()` method. Default: false. */
+    passive?: boolean;
+}
+
+interface EventListener {
+    (evt: Event): void;
+}
+
+interface EventListenerObject {
+    handleEvent(object: Event): void;
+}
+
+import {} from "events"; // Make this an ambient declaration
+declare global {
+    /** An event which takes place in the DOM. */
+    interface Event extends __Event {}
+    var Event: typeof globalThis extends { onmessage: any; Event: infer T } ? T
+        : {
+            prototype: __Event;
+            new(type: string, eventInitDict?: EventInit): __Event;
+        };
+
+    /**
+     * EventTarget is a DOM interface implemented by objects that can
+     * receive events and may have listeners for them.
+     */
+    interface EventTarget extends __EventTarget {}
+    var EventTarget: typeof globalThis extends { onmessage: any; EventTarget: infer T } ? T
+        : {
+            prototype: __EventTarget;
+            new(): __EventTarget;
+        };
+}

node v16.18/globals.d.ts

@@ -57,25 +57,29 @@ interface AbortController {
 }
 
 /** A signal object that allows you to communicate with a DOM request (such as a Fetch) and abort it if required via an AbortController object. */
-interface AbortSignal {
+interface AbortSignal extends EventTarget {
     /**
      * Returns true if this AbortSignal's AbortController has signaled to abort, and false otherwise.
      */
     readonly aborted: boolean;
     readonly reason: any;
+    onabort: null | ((this: AbortSignal, event: Event) => any);
+    throwIfAborted(): void;
 }
 
-declare var AbortController: {
-    prototype: AbortController;
-    new(): AbortController;
-};
-
-declare var AbortSignal: {
-    prototype: AbortSignal;
-    new(): AbortSignal;
-    abort(reason?: any): AbortSignal;
-    timeout(milliseconds: number): AbortSignal;
-};
+declare var AbortController: typeof globalThis extends { onmessage: any; AbortController: infer T } ? T
+    : {
+        prototype: AbortController;
+        new(): AbortController;
+    };
+
+declare var AbortSignal: typeof globalThis extends { onmessage: any; AbortSignal: infer T } ? T
+    : {
+        prototype: AbortSignal;
+        new(): AbortSignal;
+        abort(reason?: any): AbortSignal;
+        timeout(milliseconds: number): AbortSignal;
+    };
 // #endregion borrowed
 
 // #region ArrayLike.at()

node v16.18/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/node",
-    "version": "16.18.70",
+    "version": "16.18.72",
     "description": "TypeScript definitions for node",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node",
     "license": "MIT",
@@ -222,7 +222,7 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "31abc8d1d12a4367624c5740e76f7bc15ffd7060a838f692e6f99277ea9ed0e5",
+    "typesPublisherContentHash": "3c26be0f68e0f160b80f39bb43bacf01b6110c2683b6e1620d2e71bb205f0b0f",
     "typeScriptVersion": "4.6",
     "nonNpm": true
 }

node v16.18/process.d.ts

@@ -1280,6 +1280,23 @@ declare module "process" {
                  */
                 uptime(): number;
                 hrtime: HRTime;
+                /**
+                 * If the Node.js process was spawned with an IPC channel, the process.channel property is a reference to the IPC channel.
+                 * If no IPC channel exists, this property is undefined.
+                 * @since v7.1.0
+                 */
+                channel?: {
+                    /**
+                     * This method makes the IPC channel keep the event loop of the process running if .unref() has been called before.
+                     * @since v7.1.0
+                     */
+                    ref(): void;
+                    /**
+                     * This method makes the IPC channel not keep the event loop of the process running, and lets it finish even while the channel is open.
+                     * @since v7.1.0
+                     */
+                    unref(): void;
+                };
                 /**
                  * If Node.js is spawned with an IPC channel, the `process.send()` method can be
                  * used to send messages to the parent process. Messages will be received as a `'message'` event on the parent's `ChildProcess` object.

node v16.18/ts4.8/dom-events.d.ts

@@ -0,0 +1,122 @@
+export {}; // Don't export anything!
+
+//// DOM-like Events
+// NB: The Event / EventTarget / EventListener implementations below were copied
+// from lib.dom.d.ts, then edited to reflect Node's documentation at
+// https://nodejs.org/api/events.html#class-eventtarget.
+// Please read that link to understand important implementation differences.
+
+// This conditional type will be the existing global Event in a browser, or
+// the copy below in a Node environment.
+type __Event = typeof globalThis extends { onmessage: any; Event: any } ? {}
+    : {
+        /** This is not used in Node.js and is provided purely for completeness. */
+        readonly bubbles: boolean;
+        /** Alias for event.stopPropagation(). This is not used in Node.js and is provided purely for completeness. */
+        cancelBubble: () => void;
+        /** True if the event was created with the cancelable option */
+        readonly cancelable: boolean;
+        /** This is not used in Node.js and is provided purely for completeness. */
+        readonly composed: boolean;
+        /** Returns an array containing the current EventTarget as the only entry or empty if the event is not being dispatched. This is not used in Node.js and is provided purely for completeness. */
+        composedPath(): [EventTarget?];
+        /** Alias for event.target. */
+        readonly currentTarget: EventTarget | null;
+        /** Is true if cancelable is true and event.preventDefault() has been called. */
+        readonly defaultPrevented: boolean;
+        /** This is not used in Node.js and is provided purely for completeness. */
+        readonly eventPhase: 0 | 2;
+        /** The `AbortSignal` "abort" event is emitted with `isTrusted` set to `true`. The value is `false` in all other cases. */
+        readonly isTrusted: boolean;
+        /** Sets the `defaultPrevented` property to `true` if `cancelable` is `true`. */
+        preventDefault(): void;
+        /** This is not used in Node.js and is provided purely for completeness. */
+        returnValue: boolean;
+        /** Alias for event.target. */
+        readonly srcElement: EventTarget | null;
+        /** Stops the invocation of event listeners after the current one completes. */
+        stopImmediatePropagation(): void;
+        /** This is not used in Node.js and is provided purely for completeness. */
+        stopPropagation(): void;
+        /** The `EventTarget` dispatching the event */
+        readonly target: EventTarget | null;
+        /** The millisecond timestamp when the Event object was created. */
+        readonly timeStamp: number;
+        /** Returns the type of event, e.g. "click", "hashchange", or "submit". */
+        readonly type: string;
+    };
+
+// See comment above explaining conditional type
+type __EventTarget = typeof globalThis extends { onmessage: any; EventTarget: any } ? {}
+    : {
+        /**
+         * Adds a new handler for the `type` event. Any given `listener` is added only once per `type` and per `capture` option value.
+         *
+         * If the `once` option is true, the `listener` is removed after the next time a `type` event is dispatched.
+         *
+         * The `capture` option is not used by Node.js in any functional way other than tracking registered event listeners per the `EventTarget` specification.
+         * Specifically, the `capture` option is used as part of the key when registering a `listener`.
+         * Any individual `listener` may be added once with `capture = false`, and once with `capture = true`.
+         */
+        addEventListener(
+            type: string,
+            listener: EventListener | EventListenerObject,
+            options?: AddEventListenerOptions | boolean,
+        ): void;
+        /** Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise. */
+        dispatchEvent(event: Event): boolean;
+        /** Removes the event listener in target's event listener list with the same type, callback, and options. */
+        removeEventListener(
+            type: string,
+            listener: EventListener | EventListenerObject,
+            options?: EventListenerOptions | boolean,
+        ): void;
+    };
+
+interface EventInit {
+    bubbles?: boolean;
+    cancelable?: boolean;
+    composed?: boolean;
+}
+
+interface EventListenerOptions {
+    /** Not directly used by Node.js. Added for API completeness. Default: `false`. */
+    capture?: boolean;
+}
+
+interface AddEventListenerOptions extends EventListenerOptions {
+    /** When `true`, the listener is automatically removed when it is first invoked. Default: `false`. */
+    once?: boolean;
+    /** When `true`, serves as a hint that the listener will not call the `Event` object's `preventDefault()` method. Default: false. */
+    passive?: boolean;
+}
+
+interface EventListener {
+    (evt: Event): void;
+}
+
+interface EventListenerObject {
+    handleEvent(object: Event): void;
+}
+
+import {} from "events"; // Make this an ambient declaration
+declare global {
+    /** An event which takes place in the DOM. */
+    interface Event extends __Event {}
+    var Event: typeof globalThis extends { onmessage: any; Event: infer T } ? T
+        : {
+            prototype: __Event;
+            new(type: string, eventInitDict?: EventInit): __Event;
+        };
+
+    /**
+     * EventTarget is a DOM interface implemented by objects that can
+     * receive events and may have listeners for them.
+     */
+    interface EventTarget extends __EventTarget {}
+    var EventTarget: typeof globalThis extends { onmessage: any; EventTarget: infer T } ? T
+        : {
+            prototype: __EventTarget;
+            new(): __EventTarget;
+        };
+}

node v16.18/ts4.8/globals.d.ts

@@ -57,23 +57,29 @@ interface AbortController {
 }
 
 /** A signal object that allows you to communicate with a DOM request (such as a Fetch) and abort it if required via an AbortController object. */
-interface AbortSignal {
+interface AbortSignal extends EventTarget {
     /**
      * Returns true if this AbortSignal's AbortController has signaled to abort, and false otherwise.
      */
     readonly aborted: boolean;
+    readonly reason: any;
+    onabort: null | ((this: AbortSignal, event: Event) => any);
+    throwIfAborted(): void;
 }
 
-declare var AbortController: {
-    prototype: AbortController;
-    new(): AbortController;
-};
-
-declare var AbortSignal: {
-    prototype: AbortSignal;
-    new(): AbortSignal;
-    // TODO: Add abort() static
-};
+declare var AbortController: typeof globalThis extends { onmessage: any; AbortController: infer T } ? T
+    : {
+        prototype: AbortController;
+        new(): AbortController;
+    };
+
+declare var AbortSignal: typeof globalThis extends { onmessage: any; AbortSignal: infer T } ? T
+    : {
+        prototype: AbortSignal;
+        new(): AbortSignal;
+        abort(reason?: any): AbortSignal;
+        timeout(milliseconds: number): AbortSignal;
+    };
 // #endregion borrowed
 
 // #region ArrayLike.at()
@@ -87,6 +93,7 @@ interface RelativeIndexable<T> {
 }
 interface String extends RelativeIndexable<string> {}
 interface Array<T> extends RelativeIndexable<T> {}
+interface ReadonlyArray<T> extends RelativeIndexable<T> {}
 interface Int8Array extends RelativeIndexable<number> {}
 interface Uint8Array extends RelativeIndexable<number> {}
 interface Uint8ClampedArray extends RelativeIndexable<number> {}
@@ -141,7 +148,7 @@ declare namespace NodeJS {
         /**
          * Name of the script [if this function was defined in a script]
          */
-        getFileName(): string | null;
+        getFileName(): string | undefined;
 
         /**
          * Current line number [if this function was defined in a script]

node v16.18/ts4.8/process.d.ts

@@ -1280,6 +1280,23 @@ declare module "process" {
                  */
                 uptime(): number;
                 hrtime: HRTime;
+                /**
+                 * If the Node.js process was spawned with an IPC channel, the process.channel property is a reference to the IPC channel.
+                 * If no IPC channel exists, this property is undefined.
+                 * @since v7.1.0
+                 */
+                channel?: {
+                    /**
+                     * This method makes the IPC channel keep the event loop of the process running if .unref() has been called before.
+                     * @since v7.1.0
+                     */
+                    ref(): void;
+                    /**
+                     * This method makes the IPC channel not keep the event loop of the process running, and lets it finish even while the channel is open.
+                     * @since v7.1.0
+                     */
+                    unref(): void;
+                };
                 /**
                  * If Node.js is spawned with an IPC channel, the `process.send()` method can be
                  * used to send messages to the parent process. Messages will be received as a `'message'` event on the parent's `ChildProcess` object.