Initial commit: New MoreminiMore website with fresh design
This commit is contained in:
149
node_modules/p-timeout/index.d.ts
generated
vendored
Normal file
149
node_modules/p-timeout/index.d.ts
generated
vendored
Normal file
@@ -0,0 +1,149 @@
|
||||
export class TimeoutError extends Error {
|
||||
readonly name: 'TimeoutError';
|
||||
constructor(message?: string, options?: ErrorOptions);
|
||||
}
|
||||
|
||||
export type ClearablePromise<T> = {
|
||||
/**
|
||||
Clear the timeout.
|
||||
*/
|
||||
clear: () => void;
|
||||
} & Promise<T>;
|
||||
|
||||
export type Options<ReturnType> = {
|
||||
/**
|
||||
Milliseconds before timing out.
|
||||
|
||||
Passing `Infinity` will cause it to never time out.
|
||||
*/
|
||||
milliseconds: number;
|
||||
|
||||
/**
|
||||
Do something other than rejecting with an error on timeout.
|
||||
|
||||
You could for example retry:
|
||||
|
||||
@example
|
||||
```
|
||||
import {setTimeout} from 'node:timers/promises';
|
||||
import pTimeout from 'p-timeout';
|
||||
|
||||
const delayedPromise = () => setTimeout(200);
|
||||
|
||||
await pTimeout(delayedPromise(), {
|
||||
milliseconds: 50,
|
||||
fallback: () => {
|
||||
return pTimeout(delayedPromise(), {
|
||||
milliseconds: 300
|
||||
});
|
||||
},
|
||||
});
|
||||
```
|
||||
*/
|
||||
fallback?: () => ReturnType | Promise<ReturnType>;
|
||||
|
||||
/**
|
||||
Specify a custom error message or error to throw when it times out:
|
||||
|
||||
- `message: 'too slow'` will throw `TimeoutError('too slow')`
|
||||
- `message: new MyCustomError('it’s over 9000')` will throw the same error instance
|
||||
- `message: false` will make the promise resolve with `undefined` instead of rejecting
|
||||
|
||||
If you do a custom error, it's recommended to sub-class `TimeoutError`:
|
||||
|
||||
```
|
||||
import {TimeoutError} from 'p-timeout';
|
||||
|
||||
class MyCustomError extends TimeoutError {
|
||||
name = "MyCustomError";
|
||||
}
|
||||
```
|
||||
*/
|
||||
message?: string | Error | false;
|
||||
|
||||
/**
|
||||
Custom implementations for the `setTimeout` and `clearTimeout` functions.
|
||||
|
||||
Useful for testing purposes, in particular to work around [`sinon.useFakeTimers()`](https://sinonjs.org/releases/latest/fake-timers/).
|
||||
|
||||
@example
|
||||
```
|
||||
import pTimeout from 'p-timeout';
|
||||
import sinon from 'sinon';
|
||||
|
||||
const originalSetTimeout = setTimeout;
|
||||
const originalClearTimeout = clearTimeout;
|
||||
|
||||
sinon.useFakeTimers();
|
||||
|
||||
// Use `pTimeout` without being affected by `sinon.useFakeTimers()`:
|
||||
await pTimeout(doSomething(), {
|
||||
milliseconds: 2000,
|
||||
customTimers: {
|
||||
setTimeout: originalSetTimeout,
|
||||
clearTimeout: originalClearTimeout
|
||||
}
|
||||
});
|
||||
```
|
||||
*/
|
||||
readonly customTimers?: {
|
||||
setTimeout: typeof globalThis.setTimeout;
|
||||
clearTimeout: typeof globalThis.clearTimeout;
|
||||
};
|
||||
|
||||
/**
|
||||
Abort the promise.
|
||||
|
||||
@example
|
||||
```
|
||||
import pTimeout from 'p-timeout';
|
||||
import delay from 'delay';
|
||||
|
||||
const delayedPromise = delay(3000);
|
||||
|
||||
const abortController = new AbortController();
|
||||
|
||||
setTimeout(() => {
|
||||
abortController.abort();
|
||||
}, 100);
|
||||
|
||||
await pTimeout(delayedPromise, {
|
||||
milliseconds: 2000,
|
||||
signal: abortController.signal
|
||||
});
|
||||
```
|
||||
*/
|
||||
signal?: globalThis.AbortSignal;
|
||||
};
|
||||
|
||||
/**
|
||||
Timeout a promise after a specified amount of time.
|
||||
|
||||
If you pass in a cancelable promise, specifically a promise with a `.cancel()` method, that method will be called when the `pTimeout` promise times out.
|
||||
|
||||
@param input - Promise to decorate.
|
||||
@returns A decorated `input` that times out after `milliseconds` time. It has a `.clear()` method that clears the timeout.
|
||||
|
||||
@example
|
||||
```
|
||||
import {setTimeout} from 'node:timers/promises';
|
||||
import pTimeout from 'p-timeout';
|
||||
|
||||
const delayedPromise = () => setTimeout(200);
|
||||
|
||||
await pTimeout(delayedPromise(), {
|
||||
milliseconds: 50,
|
||||
fallback: () => {
|
||||
return pTimeout(delayedPromise(), {milliseconds: 300});
|
||||
}
|
||||
});
|
||||
```
|
||||
*/
|
||||
export default function pTimeout<ValueType, ReturnType = ValueType>(
|
||||
input: PromiseLike<ValueType>,
|
||||
options: Options<ReturnType> & {message: false}
|
||||
): ClearablePromise<ValueType | ReturnType | undefined>;
|
||||
export default function pTimeout<ValueType, ReturnType = ValueType>(
|
||||
input: PromiseLike<ValueType>,
|
||||
options: Options<ReturnType>
|
||||
): ClearablePromise<ValueType | ReturnType>;
|
||||
95
node_modules/p-timeout/index.js
generated
vendored
Normal file
95
node_modules/p-timeout/index.js
generated
vendored
Normal file
@@ -0,0 +1,95 @@
|
||||
export class TimeoutError extends Error {
|
||||
name = 'TimeoutError';
|
||||
|
||||
constructor(message, options) {
|
||||
super(message, options);
|
||||
Error.captureStackTrace?.(this, TimeoutError);
|
||||
}
|
||||
}
|
||||
|
||||
const getAbortedReason = signal => signal.reason ?? new DOMException('This operation was aborted.', 'AbortError');
|
||||
|
||||
export default function pTimeout(promise, options) {
|
||||
const {
|
||||
milliseconds,
|
||||
fallback,
|
||||
message,
|
||||
customTimers = {setTimeout, clearTimeout},
|
||||
signal,
|
||||
} = options;
|
||||
|
||||
let timer;
|
||||
let abortHandler;
|
||||
|
||||
const wrappedPromise = new Promise((resolve, reject) => {
|
||||
if (typeof milliseconds !== 'number' || Math.sign(milliseconds) !== 1) {
|
||||
throw new TypeError(`Expected \`milliseconds\` to be a positive number, got \`${milliseconds}\``);
|
||||
}
|
||||
|
||||
if (signal?.aborted) {
|
||||
reject(getAbortedReason(signal));
|
||||
return;
|
||||
}
|
||||
|
||||
if (signal) {
|
||||
abortHandler = () => {
|
||||
reject(getAbortedReason(signal));
|
||||
};
|
||||
|
||||
signal.addEventListener('abort', abortHandler, {once: true});
|
||||
}
|
||||
|
||||
// Use .then() instead of async IIFE to preserve stack traces
|
||||
// eslint-disable-next-line promise/prefer-await-to-then, promise/prefer-catch
|
||||
promise.then(resolve, reject);
|
||||
|
||||
if (milliseconds === Number.POSITIVE_INFINITY) {
|
||||
return;
|
||||
}
|
||||
|
||||
// We create the error outside of `setTimeout` to preserve the stack trace.
|
||||
const timeoutError = new TimeoutError();
|
||||
|
||||
// `.call(undefined, ...)` is needed for custom timers to avoid context issues
|
||||
timer = customTimers.setTimeout.call(undefined, () => {
|
||||
if (fallback) {
|
||||
try {
|
||||
resolve(fallback());
|
||||
} catch (error) {
|
||||
reject(error);
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
if (typeof promise.cancel === 'function') {
|
||||
promise.cancel();
|
||||
}
|
||||
|
||||
if (message === false) {
|
||||
resolve();
|
||||
} else if (message instanceof Error) {
|
||||
reject(message);
|
||||
} else {
|
||||
timeoutError.message = message ?? `Promise timed out after ${milliseconds} milliseconds`;
|
||||
reject(timeoutError);
|
||||
}
|
||||
}, milliseconds);
|
||||
});
|
||||
|
||||
// eslint-disable-next-line promise/prefer-await-to-then
|
||||
const cancelablePromise = wrappedPromise.finally(() => {
|
||||
cancelablePromise.clear();
|
||||
if (abortHandler && signal) {
|
||||
signal.removeEventListener('abort', abortHandler);
|
||||
}
|
||||
});
|
||||
|
||||
cancelablePromise.clear = () => {
|
||||
// `.call(undefined, ...)` is needed for custom timers to avoid context issues
|
||||
customTimers.clearTimeout.call(undefined, timer);
|
||||
timer = undefined;
|
||||
};
|
||||
|
||||
return cancelablePromise;
|
||||
}
|
||||
9
node_modules/p-timeout/license
generated
vendored
Normal file
9
node_modules/p-timeout/license
generated
vendored
Normal file
@@ -0,0 +1,9 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
52
node_modules/p-timeout/package.json
generated
vendored
Normal file
52
node_modules/p-timeout/package.json
generated
vendored
Normal file
@@ -0,0 +1,52 @@
|
||||
{
|
||||
"name": "p-timeout",
|
||||
"version": "7.0.1",
|
||||
"description": "Timeout a promise after a specified amount of time",
|
||||
"license": "MIT",
|
||||
"repository": "sindresorhus/p-timeout",
|
||||
"funding": "https://github.com/sponsors/sindresorhus",
|
||||
"author": {
|
||||
"name": "Sindre Sorhus",
|
||||
"email": "sindresorhus@gmail.com",
|
||||
"url": "https://sindresorhus.com"
|
||||
},
|
||||
"type": "module",
|
||||
"exports": {
|
||||
"types": "./index.d.ts",
|
||||
"default": "./index.js"
|
||||
},
|
||||
"sideEffects": false,
|
||||
"engines": {
|
||||
"node": ">=20"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "xo && ava && tsd"
|
||||
},
|
||||
"files": [
|
||||
"index.js",
|
||||
"index.d.ts"
|
||||
],
|
||||
"keywords": [
|
||||
"promise",
|
||||
"timeout",
|
||||
"error",
|
||||
"invalidate",
|
||||
"async",
|
||||
"await",
|
||||
"promises",
|
||||
"time",
|
||||
"out",
|
||||
"cancel",
|
||||
"bluebird"
|
||||
],
|
||||
"devDependencies": {
|
||||
"ava": "^6.4.1",
|
||||
"delay": "^6.0.0",
|
||||
"in-range": "^3.0.0",
|
||||
"p-cancelable": "^4.0.1",
|
||||
"sinon": "^21.0.0",
|
||||
"time-span": "^5.1.0",
|
||||
"tsd": "^0.33.0",
|
||||
"xo": "^1.2.2"
|
||||
}
|
||||
}
|
||||
192
node_modules/p-timeout/readme.md
generated
vendored
Normal file
192
node_modules/p-timeout/readme.md
generated
vendored
Normal file
@@ -0,0 +1,192 @@
|
||||
# p-timeout
|
||||
|
||||
> Timeout a promise after a specified amount of time
|
||||
|
||||
> [!NOTE]
|
||||
> You may want to use `AbortSignal.timeout()` instead. [Learn more.](#abortsignal)
|
||||
|
||||
## Install
|
||||
|
||||
```sh
|
||||
npm install p-timeout
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
import {setTimeout} from 'node:timers/promises';
|
||||
import pTimeout from 'p-timeout';
|
||||
|
||||
const delayedPromise = setTimeout(200);
|
||||
|
||||
await pTimeout(delayedPromise, {
|
||||
milliseconds: 50,
|
||||
});
|
||||
//=> [TimeoutError: Promise timed out after 50 milliseconds]
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
### pTimeout(input, options)
|
||||
|
||||
Returns a decorated `input` that times out after `milliseconds` time. It has a `.clear()` method that clears the timeout.
|
||||
|
||||
If you pass in a cancelable promise, specifically a promise with a `.cancel()` method, that method will be called when the `pTimeout` promise times out.
|
||||
|
||||
#### input
|
||||
|
||||
Type: `Promise`
|
||||
|
||||
Promise to decorate.
|
||||
|
||||
#### options
|
||||
|
||||
Type: `object`
|
||||
|
||||
##### milliseconds
|
||||
|
||||
Type: `number`
|
||||
|
||||
Milliseconds before timing out.
|
||||
|
||||
Passing `Infinity` will cause it to never time out.
|
||||
|
||||
##### message
|
||||
|
||||
Type: `string | Error | false`\
|
||||
Default: `'Promise timed out after {milliseconds} milliseconds'`
|
||||
|
||||
Specify a custom error message or error to throw when it times out:
|
||||
|
||||
- `message: 'too slow'` will throw `TimeoutError('too slow')`
|
||||
- `message: new MyCustomError('it’s over 9000')` will throw the same error instance
|
||||
- `message: false` will make the promise resolve with `undefined` instead of rejecting
|
||||
|
||||
If you do a custom error, it's recommended to sub-class `TimeoutError`:
|
||||
|
||||
```js
|
||||
import {TimeoutError} from 'p-timeout';
|
||||
|
||||
class MyCustomError extends TimeoutError {
|
||||
name = "MyCustomError";
|
||||
}
|
||||
```
|
||||
|
||||
##### fallback
|
||||
|
||||
Type: `Function`
|
||||
|
||||
Do something other than rejecting with an error on timeout.
|
||||
|
||||
The function can return a value or a promise.
|
||||
|
||||
You could for example retry:
|
||||
|
||||
```js
|
||||
import {setTimeout} from 'node:timers/promises';
|
||||
import pTimeout from 'p-timeout';
|
||||
|
||||
const delayedPromise = () => setTimeout(200);
|
||||
|
||||
await pTimeout(delayedPromise(), {
|
||||
milliseconds: 50,
|
||||
fallback: () => {
|
||||
return pTimeout(delayedPromise(), {
|
||||
milliseconds: 300
|
||||
});
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
##### customTimers
|
||||
|
||||
Type: `object` with function properties `setTimeout` and `clearTimeout`
|
||||
|
||||
Custom implementations for the `setTimeout` and `clearTimeout` functions.
|
||||
|
||||
Useful for testing purposes, in particular to work around [`sinon.useFakeTimers()`](https://sinonjs.org/releases/latest/fake-timers/).
|
||||
|
||||
Example:
|
||||
|
||||
```js
|
||||
import pTimeout from 'p-timeout';
|
||||
import sinon from 'sinon';
|
||||
|
||||
const originalSetTimeout = setTimeout;
|
||||
const originalClearTimeout = clearTimeout;
|
||||
|
||||
sinon.useFakeTimers();
|
||||
|
||||
// Use `pTimeout` without being affected by `sinon.useFakeTimers()`:
|
||||
await pTimeout(doSomething(), {
|
||||
milliseconds: 2000,
|
||||
customTimers: {
|
||||
setTimeout: originalSetTimeout,
|
||||
clearTimeout: originalClearTimeout
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
##### signal
|
||||
|
||||
Type: [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal)
|
||||
|
||||
Abort the promise.
|
||||
|
||||
```js
|
||||
import pTimeout from 'p-timeout';
|
||||
import delay from 'delay';
|
||||
|
||||
const delayedPromise = delay(3000);
|
||||
|
||||
const abortController = new AbortController();
|
||||
|
||||
setTimeout(() => {
|
||||
abortController.abort();
|
||||
}, 100);
|
||||
|
||||
await pTimeout(delayedPromise, {
|
||||
milliseconds: 2000,
|
||||
signal: abortController.signal
|
||||
});
|
||||
```
|
||||
|
||||
### TimeoutError
|
||||
|
||||
Exposed for instance checking and sub-classing.
|
||||
|
||||
## Related
|
||||
|
||||
- [delay](https://github.com/sindresorhus/delay) - Delay a promise a specified amount of time
|
||||
- [p-min-delay](https://github.com/sindresorhus/p-min-delay) - Delay a promise a minimum amount of time
|
||||
- [p-retry](https://github.com/sindresorhus/p-retry) - Retry a promise-returning function
|
||||
- [More…](https://github.com/sindresorhus/promise-fun)
|
||||
|
||||
## AbortSignal
|
||||
|
||||
> Modern alternative to `p-timeout`
|
||||
|
||||
Async functions like `fetch` can accept an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal), which can be conveniently created with [`AbortSignal.timeout()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/timeout_static).
|
||||
|
||||
The advantage over `p-timeout` is that the promise-generating function (like `fetch`) is actually notified that the user is no longer expecting an answer, so it can interrupt its work and free resources.
|
||||
|
||||
```js
|
||||
// Call API, timeout after 5 seconds
|
||||
const response = await fetch('./my-api', {signal: AbortSignal.timeout(5000)});
|
||||
```
|
||||
|
||||
```js
|
||||
async function buildWall(signal) {
|
||||
for (const brick of bricks) {
|
||||
signal.throwIfAborted();
|
||||
// Or: if (signal.aborted) { return; }
|
||||
|
||||
await layBrick();
|
||||
}
|
||||
}
|
||||
|
||||
// Stop long work after 60 seconds
|
||||
await buildWall(AbortSignal.timeout(60_000))
|
||||
```
|
||||
|
||||
You can also combine multiple signals, like when you have a timeout *and* an `AbortController` triggered with a “Cancel” button click. You can use the upcoming [`AbortSignal.any()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/any_static) helper or [`abort-utils`](https://github.com/fregante/abort-utils/blob/main/source/merge-signals.md).
|
||||
Reference in New Issue
Block a user