@node-red/editor-client 3.0.2 → 3.1.0-beta.2

package/public/types/node/string_decoder.d.ts

@@ -1,10 +1,67 @@
 
 /* NOTE: Do not edit directly! This file is generated using `npm run update-types` in https://github.com/Steve-Mcl/monaco-editor-esm-i18n */
 
+/**
+ * The `string_decoder` module provides an API for decoding `Buffer` objects into
+ * strings in a manner that preserves encoded multi-byte UTF-8 and UTF-16
+ * characters. It can be accessed using:
+ *
+ * ```js
+ * const { StringDecoder } = require('string_decoder');
+ * ```
+ *
+ * The following example shows the basic use of the `StringDecoder` class.
+ *
+ * ```js
+ * const { StringDecoder } = require('string_decoder');
+ * const decoder = new StringDecoder('utf8');
+ *
+ * const cent = Buffer.from([0xC2, 0xA2]);
+ * console.log(decoder.write(cent));
+ *
+ * const euro = Buffer.from([0xE2, 0x82, 0xAC]);
+ * console.log(decoder.write(euro));
+ * ```
+ *
+ * When a `Buffer` instance is written to the `StringDecoder` instance, an
+ * internal buffer is used to ensure that the decoded string does not contain
+ * any incomplete multibyte characters. These are held in the buffer until the
+ * next call to `stringDecoder.write()` or until `stringDecoder.end()` is called.
+ *
+ * In the following example, the three UTF-8 encoded bytes of the European Euro
+ * symbol (`€`) are written over three separate operations:
+ *
+ * ```js
+ * const { StringDecoder } = require('string_decoder');
+ * const decoder = new StringDecoder('utf8');
+ *
+ * decoder.write(Buffer.from([0xE2]));
+ * decoder.write(Buffer.from([0x82]));
+ * console.log(decoder.end(Buffer.from([0xAC])));
+ * ```
+ * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/string_decoder.js)
+ */
 declare module 'string_decoder' {
     class StringDecoder {
         constructor(encoding?: BufferEncoding);
+        /**
+         * Returns a decoded string, ensuring that any incomplete multibyte characters at
+         * the end of the `Buffer`, or `TypedArray`, or `DataView` are omitted from the
+         * returned string and stored in an internal buffer for the next call to`stringDecoder.write()` or `stringDecoder.end()`.
+         * @since v0.1.99
+         * @param buffer A `Buffer`, or `TypedArray`, or `DataView` containing the bytes to decode.
+         */
         write(buffer: Buffer): string;
+        /**
+         * Returns any remaining input stored in the internal buffer as a string. Bytes
+         * representing incomplete UTF-8 and UTF-16 characters will be replaced with
+         * substitution characters appropriate for the character encoding.
+         *
+         * If the `buffer` argument is provided, one final call to `stringDecoder.write()`is performed before returning the remaining input.
+         * After `end()` is called, the `stringDecoder` object can be reused for new input.
+         * @since v0.9.3
+         * @param buffer A `Buffer`, or `TypedArray`, or `DataView` containing the bytes to decode.
+         */
         end(buffer?: Buffer): string;
     }
 }

package/public/types/node/test.d.ts

@@ -0,0 +1,193 @@
+
+/* NOTE: Do not edit directly! This file is generated using `npm run update-types` in https://github.com/Steve-Mcl/monaco-editor-esm-i18n */
+
+/**
+ * The `node:test` module provides a standalone testing module.
+ * @see [source](https://github.com/nodejs/node/blob/v16.17.0/lib/test.js)
+ */
+declare module 'node:test' {
+    /**
+     * The `test()` function is the value imported from the test module. Each invocation of this
+     * function results in the creation of a test point in the TAP output.
+     *
+     * The {@link TestContext} object passed to the fn argument can be used to perform actions
+     * related to the current test. Examples include skipping the test, adding additional TAP
+     * diagnostic information, or creating subtests.
+     *
+     * `test()` returns a {@link Promise} that resolves once the test completes. The return value
+     * can usually be discarded for top level tests. However, the return value from subtests should
+     * be used to prevent the parent test from finishing first and cancelling the subtest as shown
+     * in the following example.
+     *
+     * ```js
+     * test('top level test', async (t) => {
+     *   // The setTimeout() in the following subtest would cause it to outlive its
+     *   // parent test if 'await' is removed on the next line. Once the parent test
+     *   // completes, it will cancel any outstanding subtests.
+     *   await t.test('longer running subtest', async (t) => {
+     *     return new Promise((resolve, reject) => {
+     *       setTimeout(resolve, 1000);
+     *     });
+     *   });
+     * });
+     * ```
+     * @since v16.17.0
+     * @param name The name of the test, which is displayed when reporting test results.
+     *    Default: The `name` property of fn, or `'<anonymous>'` if `fn` does not have a name.
+     * @param options Configuration options for the test
+     * @param fn The function under test. The first argument to this function is a
+     *    {@link TestContext} object. If the test uses callbacks, the callback function is
+     *    passed as the second argument. Default: A no-op function.
+     * @returns A {@link Promise} resolved with `undefined` once the test completes.
+     */
+    function test(name?: string, fn?: TestFn): Promise<void>;
+    function test(name?: string, options?: TestOptions, fn?: TestFn): Promise<void>;
+    function test(options?: TestOptions, fn?: TestFn): Promise<void>;
+    function test(fn?: TestFn): Promise<void>;
+
+    /**
+     * @since v16.17.0
+     * @param name The name of the suite, which is displayed when reporting suite results.
+     *    Default: The `name` property of fn, or `'<anonymous>'` if `fn` does not have a name.
+     * @param options Configuration options for the suite
+     * @param fn The function under suite. Default: A no-op function.
+     */
+    function describe(name?: string, options?: TestOptions, fn?: SuiteFn): void;
+    function describe(name?: string, fn?: SuiteFn): void;
+    function describe(options?: TestOptions, fn?: SuiteFn): void;
+    function describe(fn?: SuiteFn): void;
+
+    /**
+     * @since v16.17.0
+     * @param name The name of the test, which is displayed when reporting test results.
+     *    Default: The `name` property of fn, or `'<anonymous>'` if `fn` does not have a name.
+     * @param options Configuration options for the test
+     * @param fn The function under test. If the test uses callbacks, the callback function is
+     *    passed as the second argument. Default: A no-op function.
+     */
+    function it(name?: string, options?: TestOptions, fn?: ItFn): void;
+    function it(name?: string, fn?: ItFn): void;
+    function it(options?: TestOptions, fn?: ItFn): void;
+    function it(fn?: ItFn): void;
+
+    /**
+     * The type of a function under test. The first argument to this function is a
+     * {@link TestContext} object. If the test uses callbacks, the callback function is passed as
+     * the second argument.
+     */
+    type TestFn = (t: TestContext, done: (result?: any) => void) => any;
+
+    /**
+     * The type of a function under Suite.
+     * If the test uses callbacks, the callback function is passed as an argument
+     */
+    type SuiteFn = (done: (result?: any) => void) => void;
+
+    /**
+     * The type of a function under test.
+     * If the test uses callbacks, the callback function is passed as an argument
+     */
+    type ItFn = (done: (result?: any) => void) => any;
+
+    /**
+     * An instance of `TestContext` is passed to each test function in order to interact with the
+     * test runner. However, the `TestContext` constructor is not exposed as part of the API.
+     * @since v16.17.0
+     */
+    interface TestContext {
+        /**
+         * This function is used to write TAP diagnostics to the output. Any diagnostic information is
+         * included at the end of the test's results. This function does not return a value.
+         * @param message Message to be displayed as a TAP diagnostic.
+         * @since v16.17.0
+         */
+        diagnostic(message: string): void;
+
+        /**
+         * If `shouldRunOnlyTests` is truthy, the test context will only run tests that have the `only`
+         * option set. Otherwise, all tests are run. If Node.js was not started with the `--test-only`
+         * command-line option, this function is a no-op.
+         * @param shouldRunOnlyTests Whether or not to run `only` tests.
+         * @since v16.17.0
+         */
+        runOnly(shouldRunOnlyTests: boolean): void;
+
+        /**
+         * This function causes the test's output to indicate the test as skipped. If `message` is
+         * provided, it is included in the TAP output. Calling `skip()` does not terminate execution of
+         * the test function. This function does not return a value.
+         * @param message Optional skip message to be displayed in TAP output.
+         * @since v16.17.0
+         */
+        skip(message?: string): void;
+
+        /**
+         * This function adds a `TODO` directive to the test's output. If `message` is provided, it is
+         * included in the TAP output. Calling `todo()` does not terminate execution of the test
+         * function. This function does not return a value.
+         * @param message Optional `TODO` message to be displayed in TAP output.
+         * @since v16.17.0
+         */
+        todo(message?: string): void;
+
+        /**
+         * This function is used to create subtests under the current test. This function behaves in
+         * the same fashion as the top level {@link test} function.
+         * @since v16.17.0
+         * @param name The name of the test, which is displayed when reporting test results.
+         *    Default: The `name` property of fn, or `'<anonymous>'` if `fn` does not have a name.
+         * @param options Configuration options for the test
+         * @param fn The function under test. This first argument to this function is a
+         *    {@link TestContext} object. If the test uses callbacks, the callback function is
+         *    passed as the second argument. Default: A no-op function.
+         * @returns A {@link Promise} resolved with `undefined` once the test completes.
+         */
+        test: typeof test;
+    }
+
+    interface TestOptions {
+        /**
+         * The number of tests that can be run at the same time. If unspecified, subtests inherit this
+         * value from their parent.
+         * @default 1
+         */
+        concurrency?: number;
+
+        /**
+         * If truthy, and the test context is configured to run `only` tests, then this test will be
+         * run. Otherwise, the test is skipped.
+         * @default false
+         */
+        only?: boolean;
+
+        /**
+         * Allows aborting an in-progress test.
+         * @since v16.17.0
+         */
+        signal?: AbortSignal;
+
+        /**
+         * If truthy, the test is skipped. If a string is provided, that string is displayed in the
+         * test results as the reason for skipping the test.
+         * @default false
+         */
+        skip?: boolean | string;
+
+        /**
+         * A number of milliseconds the test will fail after. If unspecified, subtests inherit this
+         * value from their parent.
+         * @default Infinity
+         * @since v16.17.0
+         */
+        timeout?: number;
+
+        /**
+         * If truthy, the test marked as `TODO`. If a string is provided, that string is displayed in
+         * the test results as the reason why the test is `TODO`.
+         * @default false
+         */
+        todo?: boolean | string;
+    }
+
+    export { test as default, test, describe, it };
+}

package/public/types/node/timers/promises.d.ts

@@ -0,0 +1,96 @@
+
+/* NOTE: Do not edit directly! This file is generated using `npm run update-types` in https://github.com/Steve-Mcl/monaco-editor-esm-i18n */
+
+/**
+ * The `timers/promises` API provides an alternative set of timer functions
+ * that return `Promise` objects. The API is accessible via`require('timers/promises')`.
+ *
+ * ```js
+ * import {
+ *   setTimeout,
+ *   setImmediate,
+ *   setInterval,
+ * } from 'timers/promises';
+ * ```
+ * @since v15.0.0
+ */
+declare module 'timers/promises' {
+    import { TimerOptions } from 'node:timers';
+    /**
+     * ```js
+     * import {
+     *   setTimeout,
+     * } from 'timers/promises';
+     *
+     * const res = await setTimeout(100, 'result');
+     *
+     * console.log(res);  // Prints 'result'
+     * ```
+     * @since v15.0.0
+     * @param [delay=1] The number of milliseconds to wait before fulfilling the promise.
+     * @param value A value with which the promise is fulfilled.
+     */
+    function setTimeout<T = void>(delay?: number, value?: T, options?: TimerOptions): Promise<T>;
+    /**
+     * ```js
+     * import {
+     *   setImmediate,
+     * } from 'timers/promises';
+     *
+     * const res = await setImmediate('result');
+     *
+     * console.log(res);  // Prints 'result'
+     * ```
+     * @since v15.0.0
+     * @param value A value with which the promise is fulfilled.
+     */
+    function setImmediate<T = void>(value?: T, options?: TimerOptions): Promise<T>;
+    /**
+     * Returns an async iterator that generates values in an interval of `delay` ms.
+     *
+     * ```js
+     * import {
+     *   setInterval,
+     * } from 'timers/promises';
+     *
+     * const interval = 100;
+     * for await (const startTime of setInterval(interval, Date.now())) {
+     *   const now = Date.now();
+     *   console.log(now);
+     *   if ((now - startTime) > 1000)
+     *     break;
+     * }
+     * console.log(Date.now());
+     * ```
+     * @since v15.9.0
+     */
+    function setInterval<T = void>(delay?: number, value?: T, options?: TimerOptions): AsyncIterable<T>;
+
+    interface Scheduler {
+        /**
+         * ```js
+         * import { scheduler } from 'node:timers/promises';
+         *
+         * await scheduler.wait(1000); // Wait one second before continuing
+         * ```
+         * An experimental API defined by the Scheduling APIs draft specification being developed as a standard Web Platform API.
+         * Calling timersPromises.scheduler.wait(delay, options) is roughly equivalent to calling timersPromises.setTimeout(delay, undefined, options) except that the ref option is not supported.
+         * @since v16.14.0
+         * @experimental
+         * @param [delay=1] The number of milliseconds to wait before fulfilling the promise.
+         */
+        wait: (delay?: number, options?: TimerOptions) => Promise<void>;
+        /**
+         * An experimental API defined by the Scheduling APIs draft specification being developed as a standard Web Platform API.
+         * Calling timersPromises.scheduler.yield() is equivalent to calling timersPromises.setImmediate() with no arguments.
+         * @since v16.14.0
+         * @experimental
+         */
+        yield: () => Promise<void>;
+    }
+
+    const scheduler: Scheduler;
+}
+declare module 'node:timers/promises' {
+    export * from 'timers/promises';
+}

package/public/types/node/timers.d.ts

@@ -1,21 +1,96 @@
 
 /* NOTE: Do not edit directly! This file is generated using `npm run update-types` in https://github.com/Steve-Mcl/monaco-editor-esm-i18n */
 
+/**
+ * The `timer` module exposes a global API for scheduling functions to
+ * be called at some future period of time. Because the timer functions are
+ * globals, there is no need to call `require('timers')` to use the API.
+ *
+ * The timer functions within Node.js implement a similar API as the timers API
+ * provided by Web Browsers but use a different internal implementation that is
+ * built around the Node.js [Event Loop](https://nodejs.org/en/docs/guides/event-loop-timers-and-nexttick/#setimmediate-vs-settimeout).
+ * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/timers.js)
+ */
 declare module 'timers' {
-    function setTimeout(callback: (...args: any[]) => void, ms?: number, ...args: any[]): NodeJS.Timeout;
-    namespace setTimeout {
-        function __promisify__(ms: number): Promise<void>;
-        function __promisify__<T>(ms: number, value: T): Promise<T>;
+    import { Abortable } from 'node:events';
+    import { setTimeout as setTimeoutPromise, setImmediate as setImmediatePromise, setInterval as setIntervalPromise } from 'node:timers/promises';
+    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 | undefined;
     }
-    function clearTimeout(timeoutId: NodeJS.Timeout): void;
-    function setInterval(callback: (...args: any[]) => void, ms?: number, ...args: any[]): NodeJS.Timeout;
-    function clearInterval(intervalId: NodeJS.Timeout): void;
-    function setImmediate(callback: (...args: any[]) => void, ...args: any[]): NodeJS.Immediate;
-    namespace setImmediate {
-        function __promisify__(): Promise<void>;
-        function __promisify__<T>(value: T): Promise<T>;
+    let setTimeout: typeof global.setTimeout;
+    let clearTimeout: typeof global.clearTimeout;
+    let setInterval: typeof global.setInterval;
+    let clearInterval: typeof global.clearInterval;
+    let setImmediate: typeof global.setImmediate;
+    let clearImmediate: typeof global.clearImmediate;
+    global {
+        namespace NodeJS {
+            // compatibility with older typings
+            interface Timer extends RefCounted {
+                hasRef(): boolean;
+                refresh(): this;
+                [Symbol.toPrimitive](): number;
+            }
+            interface Immediate extends RefCounted {
+                /**
+                 * If true, the `Immediate` object will keep the Node.js event loop active.
+                 * @since v11.0.0
+                 */
+                hasRef(): boolean;
+                _onImmediate: Function; // to distinguish it from the Timeout class
+            }
+            interface Timeout extends Timer {
+                /**
+                 * If true, the `Timeout` object will keep the Node.js event loop active.
+                 * @since v11.0.0
+                 */
+                hasRef(): boolean;
+                /**
+                 * Sets the timer's start time to the current time, and reschedules the timer to
+                 * call its callback at the previously specified duration adjusted to the current
+                 * time. This is useful for refreshing a timer without allocating a new
+                 * JavaScript object.
+                 *
+                 * Using this on a timer that has already called its callback will reactivate the
+                 * timer.
+                 * @since v10.2.0
+                 * @return a reference to `timeout`
+                 */
+                refresh(): this;
+                [Symbol.toPrimitive](): number;
+            }
+        }
+        function setTimeout<TArgs extends any[]>(callback: (...args: TArgs) => void, ms?: number, ...args: TArgs): NodeJS.Timeout;
+        // util.promisify no rest args compability
+        // tslint:disable-next-line void-return
+        function setTimeout(callback: (args: void) => void, ms?: number): NodeJS.Timeout;
+        namespace setTimeout {
+            const __promisify__: typeof setTimeoutPromise;
+        }
+        function clearTimeout(timeoutId: NodeJS.Timeout | string | number | undefined): void;
+        function setInterval<TArgs extends any[]>(callback: (...args: TArgs) => void, ms?: number, ...args: TArgs): NodeJS.Timer;
+        // util.promisify no rest args compability
+        // tslint:disable-next-line void-return
+        function setInterval(callback: (args: void) => void, ms?: number): NodeJS.Timer;
+        namespace setInterval {
+            const __promisify__: typeof setIntervalPromise;
+        }
+        function clearInterval(intervalId: NodeJS.Timeout | string | number | undefined): void;
+        function setImmediate<TArgs extends any[]>(callback: (...args: TArgs) => void, ...args: TArgs): NodeJS.Immediate;
+        // util.promisify no rest args compability
+        // tslint:disable-next-line void-return
+        function setImmediate(callback: (args: void) => void): NodeJS.Immediate;
+        namespace setImmediate {
+            const __promisify__: typeof setImmediatePromise;
+        }
+        function clearImmediate(immediateId: NodeJS.Immediate | undefined): void;
+        function queueMicrotask(callback: () => void): void;
     }
-    function clearImmediate(immediateId: NodeJS.Immediate): void;
 }
 declare module 'node:timers' {
     export * from 'timers';