matterbridge 3.2.9-dev-20250926-85736bb → 3.2.9

package/dist/utils/wait.js

@@ -1,6 +1,41 @@
+/**
+ * This file contains the wait, waiter and withTimeout functions.
+ *
+ * @file wait.ts
+ * @author Luca Liguori
+ * @created 2025-02-16
+ * @version 1.0.2
+ * @license Apache-2.0
+ *
+ * Copyright 2025, 2026, 2027 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+// AnsiLogger module
 import { AnsiLogger } from 'node-ansi-logger';
+/**
+ * Asynchronous waiter function that resolves when the provided condition is met or rejects on timeout.
+ *
+ * @param {string} name - The name of the waiter.
+ * @param {() => boolean} check - A function that checks the condition. Should return a boolean.
+ * @param {boolean} [exitWithReject] - Optional. If true, the promise will be rejected on timeout. Default is false.
+ * @param {number} [resolveTimeout] - Optional. The timeout duration in milliseconds. Default is 5000ms.
+ * @param {number} [resolveInterval] - Optional. The interval duration in milliseconds between condition checks. Default is 500ms.
+ * @param {boolean} [debug] - Optional. If true, debug messages will be logged to the console. Default is false.
+ * @returns {Promise<boolean>} A promise that resolves to true when the condition is met, or false if the timeout occurs.
+ */
 export async function waiter(name, check, exitWithReject = false, resolveTimeout = 5000, resolveInterval = 500, debug = false) {
-    const log = new AnsiLogger({ logName: 'Waiter', logTimestampFormat: 4, logLevel: "debug" });
+    const log = new AnsiLogger({ logName: 'Waiter', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: "debug" /* LogLevel.DEBUG */ });
     if (check()) {
         if (debug)
             log.debug(`Waiter "${name}" already true`);
@@ -31,8 +66,16 @@ export async function waiter(name, check, exitWithReject = false, resolveTimeout
         }, resolveInterval).unref();
     });
 }
+/**
+ * Asynchronously waits for a specified amount of time.
+ *
+ * @param {number} timeout - The duration to wait in milliseconds. Default is 1000ms.
+ * @param {string} name - The name of the wait operation. Default is undefined.
+ * @param {boolean} debug - Whether to enable debug logging. Default is false.
+ * @returns {Promise<void>} A Promise that resolves after the specified timeout.
+ */
 export async function wait(timeout = 1000, name, debug = false) {
-    const log = new AnsiLogger({ logName: 'Wait', logTimestampFormat: 4, logLevel: "debug" });
+    const log = new AnsiLogger({ logName: 'Wait', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: "debug" /* LogLevel.DEBUG */ });
     if (debug)
         log.debug(`Wait "${name}" started...`);
     return new Promise((resolve) => {
@@ -44,6 +87,14 @@ export async function wait(timeout = 1000, name, debug = false) {
         }, timeout).unref();
     });
 }
+/**
+ * Wraps a promise with a timeout. If the promise does not resolve or reject within the specified time, it will be rejected.
+ *
+ * @param {Promise<T>} promise - The promise to wrap.
+ * @param {number} [timeoutMillisecs] - The timeout duration in milliseconds. Default is 10000ms.
+ * @param {boolean} [reThrow] - Optional. If true, the promise will rethrow the original promise and will reject on timeout. Default is true.
+ * @returns {Promise<T>} A new promise that resolves or rejects based on the original promise and the timeout.
+ */
 export function withTimeout(promise, timeoutMillisecs = 10000, reThrow = true) {
     return new Promise((resolve, reject) => {
         const timer = setTimeout(() => {
@@ -51,23 +102,24 @@ export function withTimeout(promise, timeoutMillisecs = 10000, reThrow = true) {
                 reject(new Error('Operation timed out'));
             }
             else {
-                resolve(undefined);
+                resolve(undefined); // Resolve with undefined if reThrow is false
             }
-        }, timeoutMillisecs).unref();
+        }, timeoutMillisecs).unref(); // Unref the timer to prevent it from keeping the event loop alive
         promise
             .then((result) => {
-            clearTimeout(timer);
+            clearTimeout(timer); // Ensure timeout does not fire if promise resolves first
             resolve(result);
             return result;
         })
             .catch((error) => {
-            clearTimeout(timer);
+            clearTimeout(timer); // Ensure timeout does not fire if promise rejects first
             if (reThrow) {
-                reject(error);
+                reject(error); // Reject with the original error
             }
             else {
-                resolve(undefined);
+                resolve(undefined); // Resolve with undefined if reThrow is false
             }
         });
     });
 }
+//# sourceMappingURL=wait.js.map

package/dist/utils/wait.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wait.js","sourceRoot":"","sources":["../../src/utils/wait.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,oBAAoB;AACpB,OAAO,EAAE,UAAU,EAA6B,MAAM,kBAAkB,CAAC;AAEzE;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,IAAY,EAAE,KAAoB,EAAE,iBAA0B,KAAK,EAAE,iBAAyB,IAAI,EAAE,kBAA0B,GAAG,EAAE,QAAiB,KAAK;IACpL,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,kBAAkB,qCAA6B,EAAE,QAAQ,8BAAgB,EAAE,CAAC,CAAC;IAC7H,IAAI,KAAK,EAAE,EAAE,CAAC;QACZ,IAAI,KAAK;YAAE,GAAG,CAAC,KAAK,CAAC,WAAW,IAAI,gBAAgB,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,KAAK;QAAE,GAAG,CAAC,KAAK,CAAC,WAAW,IAAI,cAAc,CAAC,CAAC;IACpD,OAAO,IAAI,OAAO,CAAU,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC9C,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;YAChC,IAAI,KAAK;gBAAE,GAAG,CAAC,KAAK,CAAC,WAAW,IAAI,2BAA2B,CAAC,CAAC;YACjE,YAAY,CAAC,SAAS,CAAC,CAAC;YACxB,aAAa,CAAC,UAAU,CAAC,CAAC;YAC1B,IAAI,cAAc;gBAAE,MAAM,CAAC,IAAI,KAAK,CAAC,WAAW,IAAI,2BAA2B,CAAC,CAAC,CAAC;;gBAC7E,OAAO,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC,EAAE,cAAc,CAAC,CAAC,KAAK,EAAE,CAAC;QAE3B,MAAM,UAAU,GAAG,WAAW,CAAC,KAAK,IAAI,EAAE;YACxC,IAAI,KAAK,EAAE,EAAE,CAAC;gBACZ,IAAI,KAAK;oBAAE,GAAG,CAAC,KAAK,CAAC,WAAW,IAAI,kCAAkC,CAAC,CAAC;gBACxE,YAAY,CAAC,SAAS,CAAC,CAAC;gBACxB,aAAa,CAAC,UAAU,CAAC,CAAC;gBAC1B,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC;YACD,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;QAC1B,CAAC,EAAE,eAAe,CAAC,CAAC,KAAK,EAAE,CAAC;IAC9B,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,UAAkB,IAAI,EAAE,IAAa,EAAE,QAAiB,KAAK;IACtF,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,kBAAkB,qCAA6B,EAAE,QAAQ,8BAAgB,EAAE,CAAC,CAAC;IAC3H,IAAI,KAAK;QAAE,GAAG,CAAC,KAAK,CAAC,SAAS,IAAI,cAAc,CAAC,CAAC;IAElD,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;QACnC,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;YAChC,IAAI,KAAK;gBAAE,GAAG,CAAC,KAAK,CAAC,SAAS,IAAI,eAAe,CAAC,CAAC;YACnD,YAAY,CAAC,SAAS,CAAC,CAAC;YACxB,OAAO,EAAE,CAAC;QACZ,CAAC,EAAE,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW,CAAI,OAAmB,EAAE,mBAA2B,KAAK,EAAE,UAAmB,IAAI;IAC3G,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACxC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;YAC5B,IAAI,OAAO,EAAE,CAAC;gBACZ,MAAM,CAAC,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC;YAC3C,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,SAAyB,CAAC,CAAC,CAAC,6CAA6C;YACnF,CAAC;QACH,CAAC,EAAE,gBAAgB,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,kEAAkE;QAChG,OAAO;aACJ,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACf,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,yDAAyD;YAC9E,OAAO,CAAC,MAAM,CAAC,CAAC;YAChB,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,wDAAwD;YAC7E,IAAI,OAAO,EAAE,CAAC;gBACZ,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,iCAAiC;YAClD,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,SAAyB,CAAC,CAAC,CAAC,6CAA6C;YACnF,CAAC;QACH,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC"}