@types/node 14.0.15 → 14.0.19

node/README.md

@@ -8,9 +8,9 @@ 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: Mon, 06 Jul 2020 20:44:09 GMT
+ * Last updated: Tue, 07 Jul 2020 17:24:48 GMT
  * Dependencies: none
- * Global values: `Buffer`, `Symbol`, `__dirname`, `__filename`, `clearImmediate`, `clearInterval`, `clearTimeout`, `console`, `exports`, `global`, `module`, `process`, `queueMicrotask`, `require`, `setImmediate`, `setInterval`, `setTimeout`
+ * Global values: `Symbol`, `__dirname`, `__filename`, `clearImmediate`, `clearInterval`, `clearTimeout`, `exports`, `global`, `module`, `queueMicrotask`, `require`, `setImmediate`, `setInterval`, `setTimeout`
 
 # Credits
 These definitions were written by [Microsoft TypeScript](https://github.com/Microsoft), [DefinitelyTyped](https://github.com/DefinitelyTyped), [Alberto Schiabel](https://github.com/jkomyno), [Alexander T.](https://github.com/a-tarasyuk), [Alvis HT Tang](https://github.com/alvis), [Andrew Makarov](https://github.com/r3nya), [Benjamin Toueg](https://github.com/btoueg), [Bruno Scheufler](https://github.com/brunoscheufler), [Chigozirim C.](https://github.com/smac89), [David Junger](https://github.com/touffy), [Deividas Bakanas](https://github.com/DeividasBakanas), [Eugene Y. Q. Shen](https://github.com/eyqs), [Flarna](https://github.com/Flarna), [Hannes Magnusson](https://github.com/Hannes-Magnusson-CK), [Hoàng Văn Khải](https://github.com/KSXGitHub), [Huw](https://github.com/hoo29), [Kelvin Jin](https://github.com/kjin), [Klaus Meinhardt](https://github.com/ajafff), [Lishude](https://github.com/islishude), [Mariusz Wiktorczyk](https://github.com/mwiktorczyk), [Mohsen Azimi](https://github.com/mohsen1), [Nicolas Even](https://github.com/n-e), [Nicolas Voigt](https://github.com/octo-sniffle), [Nikita Galkin](https://github.com/galkin), [Parambir Singh](https://github.com/parambirs), [Sebastian Silbermann](https://github.com/eps1lon), [Simon Schick](https://github.com/SimonSchick), [Thomas den Hollander](https://github.com/ThomasdenH), [Wilco Bakker](https://github.com/WilcoBakker), [wwwy3y3](https://github.com/wwwy3y3), [Samuel Ainsworth](https://github.com/samuela), [Kyle Uehlein](https://github.com/kuehlein), [Jordi Oliveras Rovira](https://github.com/j-oliveras), [Thanik Bhongbhibhat](https://github.com/bhongy), [Marcin Kopacz](https://github.com/chyzwar), [Trivikram Kamat](https://github.com/trivikr), [Minh Son Nguyen](https://github.com/nguymin4), [Junxiao Shi](https://github.com/yoursunny), [Ilia Baryshnikov](https://github.com/qwelias), [ExE Boss](https://github.com/ExE-Boss), [Surasak Chaisurin](https://github.com/Ryan-Willpower), [Piotr Błażejewicz](https://github.com/peterblazejewicz), [Anna Henningsen](https://github.com/addaleax), and [Jason Kwok](https://github.com/JasonHK).

node/buffer.d.ts

@@ -6,7 +6,6 @@ declare module "buffer" {
         MAX_LENGTH: number;
         MAX_STRING_LENGTH: number;
     };
-    const BuffType: typeof Buffer;
 
     export type TranscodeEncoding = "ascii" | "utf8" | "utf16le" | "ucs2" | "latin1" | "binary";
 
@@ -18,5 +17,244 @@ declare module "buffer" {
         prototype: Buffer;
     };
 
-    export { BuffType as Buffer };
+    global {
+        // Buffer class
+        type BufferEncoding = "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "latin1" | "binary" | "hex";
+
+        /**
+         * Raw data is stored in instances of the Buffer class.
+         * A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap.  A Buffer cannot be resized.
+         * Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex'
+         */
+        class Buffer extends Uint8Array {
+            /**
+             * Allocates a new buffer containing the given {str}.
+             *
+             * @param str String to store in buffer.
+             * @param encoding encoding to use, optional.  Default is 'utf8'
+             * @deprecated since v10.0.0 - Use `Buffer.from(string[, encoding])` instead.
+             */
+            constructor(str: string, encoding?: BufferEncoding);
+            /**
+             * Allocates a new buffer of {size} octets.
+             *
+             * @param size count of octets to allocate.
+             * @deprecated since v10.0.0 - Use `Buffer.alloc()` instead (also see `Buffer.allocUnsafe()`).
+             */
+            constructor(size: number);
+            /**
+             * Allocates a new buffer containing the given {array} of octets.
+             *
+             * @param array The octets to store.
+             * @deprecated since v10.0.0 - Use `Buffer.from(array)` instead.
+             */
+            constructor(array: Uint8Array);
+            /**
+             * Produces a Buffer backed by the same allocated memory as
+             * the given {ArrayBuffer}/{SharedArrayBuffer}.
+             *
+             *
+             * @param arrayBuffer The ArrayBuffer with which to share memory.
+             * @deprecated since v10.0.0 - Use `Buffer.from(arrayBuffer[, byteOffset[, length]])` instead.
+             */
+            constructor(arrayBuffer: ArrayBuffer | SharedArrayBuffer);
+            /**
+             * Allocates a new buffer containing the given {array} of octets.
+             *
+             * @param array The octets to store.
+             * @deprecated since v10.0.0 - Use `Buffer.from(array)` instead.
+             */
+            constructor(array: any[]);
+            /**
+             * Copies the passed {buffer} data onto a new {Buffer} instance.
+             *
+             * @param buffer The buffer to copy.
+             * @deprecated since v10.0.0 - Use `Buffer.from(buffer)` instead.
+             */
+            constructor(buffer: Buffer);
+            /**
+             * When passed a reference to the .buffer property of a TypedArray instance,
+             * the newly created Buffer will share the same allocated memory as the TypedArray.
+             * The optional {byteOffset} and {length} arguments specify a memory range
+             * within the {arrayBuffer} that will be shared by the Buffer.
+             *
+             * @param arrayBuffer The .buffer property of any TypedArray or a new ArrayBuffer()
+             */
+            static from(arrayBuffer: ArrayBuffer | SharedArrayBuffer, byteOffset?: number, length?: number): Buffer;
+            /**
+             * Creates a new Buffer using the passed {data}
+             * @param data data to create a new Buffer
+             */
+            static from(data: number[]): Buffer;
+            static from(data: Uint8Array): Buffer;
+            /**
+             * Creates a new buffer containing the coerced value of an object
+             * A `TypeError` will be thrown if {obj} has not mentioned methods or is not of other type appropriate for `Buffer.from()` variants.
+             * @param obj An object supporting `Symbol.toPrimitive` or `valueOf()`.
+             */
+            static from(obj: { valueOf(): string | object } | { [Symbol.toPrimitive](hint: 'string'): string }, byteOffset?: number, length?: number): Buffer;
+            /**
+             * Creates a new Buffer containing the given JavaScript string {str}.
+             * If provided, the {encoding} parameter identifies the character encoding.
+             * If not provided, {encoding} defaults to 'utf8'.
+             */
+            static from(str: string, encoding?: BufferEncoding): Buffer;
+            /**
+             * Creates a new Buffer using the passed {data}
+             * @param values to create a new Buffer
+             */
+            static of(...items: number[]): Buffer;
+            /**
+             * Returns true if {obj} is a Buffer
+             *
+             * @param obj object to test.
+             */
+            static isBuffer(obj: any): obj is Buffer;
+            /**
+             * Returns true if {encoding} is a valid encoding argument.
+             * Valid string encodings in Node 0.12: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex'
+             *
+             * @param encoding string to test.
+             */
+            static isEncoding(encoding: string): encoding is BufferEncoding;
+            /**
+             * Gives the actual byte length of a string. encoding defaults to 'utf8'.
+             * This is not the same as String.prototype.length since that returns the number of characters in a string.
+             *
+             * @param string string to test.
+             * @param encoding encoding used to evaluate (defaults to 'utf8')
+             */
+            static byteLength(
+                string: string | NodeJS.ArrayBufferView | ArrayBuffer | SharedArrayBuffer,
+                encoding?: BufferEncoding
+            ): number;
+            /**
+             * Returns a buffer which is the result of concatenating all the buffers in the list together.
+             *
+             * If the list has no items, or if the totalLength is 0, then it returns a zero-length buffer.
+             * If the list has exactly one item, then the first item of the list is returned.
+             * If the list has more than one item, then a new Buffer is created.
+             *
+             * @param list An array of Buffer objects to concatenate
+             * @param totalLength Total length of the buffers when concatenated.
+             *   If totalLength is not provided, it is read from the buffers in the list. However, this adds an additional loop to the function, so it is faster to provide the length explicitly.
+             */
+            static concat(list: Uint8Array[], totalLength?: number): Buffer;
+            /**
+             * The same as buf1.compare(buf2).
+             */
+            static compare(buf1: Uint8Array, buf2: Uint8Array): number;
+            /**
+             * Allocates a new buffer of {size} octets.
+             *
+             * @param size count of octets to allocate.
+             * @param fill if specified, buffer will be initialized by calling buf.fill(fill).
+             *    If parameter is omitted, buffer will be filled with zeros.
+             * @param encoding encoding used for call to buf.fill while initalizing
+             */
+            static alloc(size: number, fill?: string | Buffer | number, encoding?: BufferEncoding): Buffer;
+            /**
+             * Allocates a new buffer of {size} octets, leaving memory not initialized, so the contents
+             * of the newly created Buffer are unknown and may contain sensitive data.
+             *
+             * @param size count of octets to allocate
+             */
+            static allocUnsafe(size: number): Buffer;
+            /**
+             * Allocates a new non-pooled buffer of {size} octets, leaving memory not initialized, so the contents
+             * of the newly created Buffer are unknown and may contain sensitive data.
+             *
+             * @param size count of octets to allocate
+             */
+            static allocUnsafeSlow(size: number): Buffer;
+            /**
+             * This is the number of bytes used to determine the size of pre-allocated, internal Buffer instances used for pooling. This value may be modified.
+             */
+            static poolSize: number;
+
+            write(string: string, encoding?: BufferEncoding): number;
+            write(string: string, offset: number, encoding?: BufferEncoding): number;
+            write(string: string, offset: number, length: number, encoding?: BufferEncoding): number;
+            toString(encoding?: BufferEncoding, start?: number, end?: number): string;
+            toJSON(): { type: 'Buffer'; data: number[] };
+            equals(otherBuffer: Uint8Array): boolean;
+            compare(
+                otherBuffer: Uint8Array,
+                targetStart?: number,
+                targetEnd?: number,
+                sourceStart?: number,
+                sourceEnd?: number
+            ): number;
+            copy(targetBuffer: Uint8Array, targetStart?: number, sourceStart?: number, sourceEnd?: number): number;
+            /**
+             * Returns a new `Buffer` that references **the same memory as the original**, but offset and cropped by the start and end indices.
+             *
+             * This method is incompatible with `Uint8Array#slice()`, which returns a copy of the original memory.
+             *
+             * @param begin Where the new `Buffer` will start. Default: `0`.
+             * @param end Where the new `Buffer` will end (not inclusive). Default: `buf.length`.
+             */
+            slice(begin?: number, end?: number): Buffer;
+            /**
+             * Returns a new `Buffer` that references **the same memory as the original**, but offset and cropped by the start and end indices.
+             *
+             * This method is compatible with `Uint8Array#subarray()`.
+             *
+             * @param begin Where the new `Buffer` will start. Default: `0`.
+             * @param end Where the new `Buffer` will end (not inclusive). Default: `buf.length`.
+             */
+            subarray(begin?: number, end?: number): Buffer;
+            writeUIntLE(value: number, offset: number, byteLength: number): number;
+            writeUIntBE(value: number, offset: number, byteLength: number): number;
+            writeIntLE(value: number, offset: number, byteLength: number): number;
+            writeIntBE(value: number, offset: number, byteLength: number): number;
+            readUIntLE(offset: number, byteLength: number): number;
+            readUIntBE(offset: number, byteLength: number): number;
+            readIntLE(offset: number, byteLength: number): number;
+            readIntBE(offset: number, byteLength: number): number;
+            readUInt8(offset?: number): number;
+            readUInt16LE(offset?: number): number;
+            readUInt16BE(offset?: number): number;
+            readUInt32LE(offset?: number): number;
+            readUInt32BE(offset?: number): number;
+            readInt8(offset?: number): number;
+            readInt16LE(offset?: number): number;
+            readInt16BE(offset?: number): number;
+            readInt32LE(offset?: number): number;
+            readInt32BE(offset?: number): number;
+            readFloatLE(offset?: number): number;
+            readFloatBE(offset?: number): number;
+            readDoubleLE(offset?: number): number;
+            readDoubleBE(offset?: number): number;
+            reverse(): this;
+            swap16(): Buffer;
+            swap32(): Buffer;
+            swap64(): Buffer;
+            writeUInt8(value: number, offset?: number): number;
+            writeUInt16LE(value: number, offset?: number): number;
+            writeUInt16BE(value: number, offset?: number): number;
+            writeUInt32LE(value: number, offset?: number): number;
+            writeUInt32BE(value: number, offset?: number): number;
+            writeInt8(value: number, offset?: number): number;
+            writeInt16LE(value: number, offset?: number): number;
+            writeInt16BE(value: number, offset?: number): number;
+            writeInt32LE(value: number, offset?: number): number;
+            writeInt32BE(value: number, offset?: number): number;
+            writeFloatLE(value: number, offset?: number): number;
+            writeFloatBE(value: number, offset?: number): number;
+            writeDoubleLE(value: number, offset?: number): number;
+            writeDoubleBE(value: number, offset?: number): number;
+
+            fill(value: string | Uint8Array | number, offset?: number, end?: number, encoding?: BufferEncoding): this;
+
+            indexOf(value: string | number | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): number;
+            lastIndexOf(value: string | number | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): number;
+            entries(): IterableIterator<[number, number]>;
+            includes(value: string | number | Buffer, byteOffset?: number, encoding?: BufferEncoding): boolean;
+            keys(): IterableIterator<number>;
+            values(): IterableIterator<number>;
+        }
+    }
+
+    export { Buffer };
 }

node/console.d.ts

@@ -1,3 +1,133 @@
 declare module "console" {
+    import { InspectOptions } from 'util';
+
+    global {
+        // This needs to be global to avoid TS2403 in case lib.dom.d.ts is present in the same build
+        interface Console {
+            Console: NodeJS.ConsoleConstructor;
+            /**
+             * A simple assertion test that verifies whether `value` is truthy.
+             * If it is not, an `AssertionError` is thrown.
+             * If provided, the error `message` is formatted using `util.format()` and used as the error message.
+             */
+            assert(value: any, message?: string, ...optionalParams: any[]): void;
+            /**
+             * When `stdout` is a TTY, calling `console.clear()` will attempt to clear the TTY.
+             * When `stdout` is not a TTY, this method does nothing.
+             */
+            clear(): void;
+            /**
+             * Maintains an internal counter specific to `label` and outputs to `stdout` the number of times `console.count()` has been called with the given `label`.
+             */
+            count(label?: string): void;
+            /**
+             * Resets the internal counter specific to `label`.
+             */
+            countReset(label?: string): void;
+            /**
+             * The `console.debug()` function is an alias for {@link console.log()}.
+             */
+            debug(message?: any, ...optionalParams: any[]): void;
+            /**
+             * Uses {@link util.inspect()} on `obj` and prints the resulting string to `stdout`.
+             * This function bypasses any custom `inspect()` function defined on `obj`.
+             */
+            dir(obj: any, options?: InspectOptions): void;
+            /**
+             * This method calls {@link console.log()} passing it the arguments received. Please note that this method does not produce any XML formatting
+             */
+            dirxml(...data: any[]): void;
+            /**
+             * Prints to `stderr` with newline.
+             */
+            error(message?: any, ...optionalParams: any[]): void;
+            /**
+             * Increases indentation of subsequent lines by two spaces.
+             * If one or more `label`s are provided, those are printed first without the additional indentation.
+             */
+            group(...label: any[]): void;
+            /**
+             * The `console.groupCollapsed()` function is an alias for {@link console.group()}.
+             */
+            groupCollapsed(...label: any[]): void;
+            /**
+             * Decreases indentation of subsequent lines by two spaces.
+             */
+            groupEnd(): void;
+            /**
+             * The {@link console.info()} function is an alias for {@link console.log()}.
+             */
+            info(message?: any, ...optionalParams: any[]): void;
+            /**
+             * Prints to `stdout` with newline.
+             */
+            log(message?: any, ...optionalParams: any[]): void;
+            /**
+             * This method does not display anything unless used in the inspector.
+             *  Prints to `stdout` the array `array` formatted as a table.
+             */
+            table(tabularData: any, properties?: string[]): void;
+            /**
+             * Starts a timer that can be used to compute the duration of an operation. Timers are identified by a unique `label`.
+             */
+            time(label?: string): void;
+            /**
+             * Stops a timer that was previously started by calling {@link console.time()} and prints the result to `stdout`.
+             */
+            timeEnd(label?: string): void;
+            /**
+             * For a timer that was previously started by calling {@link console.time()}, prints the elapsed time and other `data` arguments to `stdout`.
+             */
+            timeLog(label?: string, ...data: any[]): void;
+            /**
+             * Prints to `stderr` the string 'Trace :', followed by the {@link util.format()} formatted message and stack trace to the current position in the code.
+             */
+            trace(message?: any, ...optionalParams: any[]): void;
+            /**
+             * The {@link console.warn()} function is an alias for {@link console.error()}.
+             */
+            warn(message?: any, ...optionalParams: any[]): void;
+
+            // --- Inspector mode only ---
+            /**
+             * This method does not display anything unless used in the inspector.
+             *  Starts a JavaScript CPU profile with an optional label.
+             */
+            profile(label?: string): void;
+            /**
+             * This method does not display anything unless used in the inspector.
+             *  Stops the current JavaScript CPU profiling session if one has been started and prints the report to the Profiles panel of the inspector.
+             */
+            profileEnd(label?: string): void;
+            /**
+             * This method does not display anything unless used in the inspector.
+             *  Adds an event with the label `label` to the Timeline panel of the inspector.
+             */
+            timeStamp(label?: string): void;
+        }
+
+        var console: Console;
+
+        namespace NodeJS {
+            interface ConsoleConstructorOptions {
+                stdout: WritableStream;
+                stderr?: WritableStream;
+                ignoreErrors?: boolean;
+                colorMode?: boolean | 'auto';
+                inspectOptions?: InspectOptions;
+            }
+
+            interface ConsoleConstructor {
+                prototype: Console;
+                new(stdout: WritableStream, stderr?: WritableStream, ignoreErrors?: boolean): Console;
+                new(options: ConsoleConstructorOptions): Console;
+            }
+
+            interface Global {
+                console: typeof console;
+            }
+        }
+    }
+
     export = console;
 }

node/domain.d.ts

@@ -1,12 +1,20 @@
 declare module "domain" {
     import { EventEmitter } from "events";
 
-    class Domain extends EventEmitter implements NodeJS.Domain {
-        run<T>(fn: (...args: any[]) => T, ...args: any[]): T;
-        add(emitter: EventEmitter | NodeJS.Timer): void;
-        remove(emitter: EventEmitter | NodeJS.Timer): void;
-        bind<T extends Function>(cb: T): T;
-        intercept<T extends Function>(cb: T): T;
+    global {
+        namespace NodeJS {
+            interface Domain extends EventEmitter {
+                run<T>(fn: (...args: any[]) => T, ...args: any[]): T;
+                add(emitter: EventEmitter | Timer): void;
+                remove(emitter: EventEmitter | Timer): void;
+                bind<T extends Function>(cb: T): T;
+                intercept<T extends Function>(cb: T): T;
+            }
+        }
+    }
+
+    interface Domain extends NodeJS.Domain {}
+    class Domain extends EventEmitter {
         members: Array<EventEmitter | NodeJS.Timer>;
         enter(): void;
         exit(): void;

node/events.d.ts

@@ -56,5 +56,28 @@ declare module "events" {
         }
     }
 
+    global {
+        namespace NodeJS {
+            interface EventEmitter {
+                addListener(event: string | symbol, listener: (...args: any[]) => void): this;
+                on(event: string | symbol, listener: (...args: any[]) => void): this;
+                once(event: string | symbol, listener: (...args: any[]) => void): this;
+                removeListener(event: string | symbol, listener: (...args: any[]) => void): this;
+                off(event: string | symbol, listener: (...args: any[]) => void): this;
+                removeAllListeners(event?: string | symbol): this;
+                setMaxListeners(n: number): this;
+                getMaxListeners(): number;
+                listeners(event: string | symbol): Function[];
+                rawListeners(event: string | symbol): Function[];
+                emit(event: string | symbol, ...args: any[]): boolean;
+                listenerCount(type: string | symbol): number;
+                // Added in Node 6...
+                prependListener(event: string | symbol, listener: (...args: any[]) => void): this;
+                prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this;
+                eventNames(): Array<string | symbol>;
+            }
+        }
+    }
+
     export = EventEmitter;
 }