@cahil/utils › Globals › async
▸ makeCancelable<T>(promise: Promise‹T›): CancelableWrappedPromise‹T›
Defined in src/async/makeCancelable.ts:44
Allows the provided promise to be canceled after starting. This does not stop the promise from executing but will
cause it to reject with the value { isCanceled: true } once it finishes, regardless of outcome.
example
const promise = new Promise((res, rej) => {
setTimeout(() => res('I finished!'), 3000)
})
// Create a cancelable version of the promise
const cancelablePromise = makeCancelable(promise)
// Stop the cancelable promise from resolving
cancelablePromise.cancel()
promise
.then(result => console.log('Normal', result)) // This will log `'I finished!'` after 3000ms
.catch(err => console.log('Normal', err)) // Will reject as per normal
cancelablePromise
.then(result => console.log('Cancelable', result)) // Never fires, the promise will not resolve after being cancelled
.catch(err => console.log('Cancelable', err)) // Resolves after 3000ms with the value `{ isCanceled: true }`
Type parameters:
▪ T
Parameters:
| Name | Type | Description |
|---|---|---|
promise |
Promise‹T› | The promise that is executing |
Returns: CancelableWrappedPromise‹T›
The cancelable version of the promise
▸ pause(ms: number): Promise‹unknown›
Defined in src/async/pause.ts:27
Creates a promise that resolves in the provided number of milliseconds.
This function is basically a promise version of setTimeout
example
async function run() {
console.log('first log')
await pause(500)
// Will run 500 milliseconds after the first
console.log('second log')
}
Parameters:
| Name | Type | Description |
|---|---|---|
ms |
number | The number of ms to pause for |
Returns: Promise‹unknown›
The executing promise
Const canceledErrorDefined in src/async/makeCancelable.ts:6
An error that indicates a promise has rejected because it was canceled
• isCanceled: boolean = true
Defined in src/async/makeCancelable.ts:6