aboutsummaryrefslogtreecommitdiff
path: root/node_modules/p-try/index.d.ts
diff options
context:
space:
mode:
authorJoel Kronqvist <work.joelkronqvist@pm.me>2022-03-11 20:46:06 +0200
committerJoel Kronqvist <work.joelkronqvist@pm.me>2022-03-11 20:46:06 +0200
commit080c5819d87b933816d724a83f3bf4f1686770a7 (patch)
tree4a2ccc68b27edf7d4cbc586c932cc7542b655e19 /node_modules/p-try/index.d.ts
parent5ac7049a9d30733165cc212dee308163c2a14644 (diff)
parentd003b82235a9329f912522a2f70aa950dfce4998 (diff)
downloadLYLLRuoka-080c5819d87b933816d724a83f3bf4f1686770a7.tar.gz
LYLLRuoka-080c5819d87b933816d724a83f3bf4f1686770a7.zip
Merge branch 'master' of https://github.com/JoelHMikael/FoodJS
Updating remote changes
Diffstat (limited to 'node_modules/p-try/index.d.ts')
-rw-r--r--node_modules/p-try/index.d.ts39
1 files changed, 39 insertions, 0 deletions
diff --git a/node_modules/p-try/index.d.ts b/node_modules/p-try/index.d.ts
new file mode 100644
index 0000000..2a7319e
--- /dev/null
+++ b/node_modules/p-try/index.d.ts
@@ -0,0 +1,39 @@
+declare const pTry: {
+ /**
+ Start a promise chain.
+
+ @param fn - The function to run to start the promise chain.
+ @param arguments - Arguments to pass to `fn`.
+ @returns The value of calling `fn(...arguments)`. If the function throws an error, the returned `Promise` will be rejected with that error.
+
+ @example
+ ```
+ import pTry = require('p-try');
+
+ (async () => {
+ try {
+ const value = await pTry(() => {
+ return synchronousFunctionThatMightThrow();
+ });
+ console.log(value);
+ } catch (error) {
+ console.error(error);
+ }
+ })();
+ ```
+ */
+ <ValueType, ArgumentsType extends unknown[]>(
+ fn: (...arguments: ArgumentsType) => PromiseLike<ValueType> | ValueType,
+ ...arguments: ArgumentsType
+ ): Promise<ValueType>;
+
+ // TODO: remove this in the next major version, refactor the whole definition to:
+ // declare function pTry<ValueType, ArgumentsType extends unknown[]>(
+ // fn: (...arguments: ArgumentsType) => PromiseLike<ValueType> | ValueType,
+ // ...arguments: ArgumentsType
+ // ): Promise<ValueType>;
+ // export = pTry;
+ default: typeof pTry;
+};
+
+export = pTry;