aboutsummaryrefslogtreecommitdiff
path: root/node_modules/@kwsites/promise-deferred/dist/index.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/@kwsites/promise-deferred/dist/index.d.ts')
-rw-r--r--node_modules/@kwsites/promise-deferred/dist/index.d.ts49
1 files changed, 0 insertions, 49 deletions
diff --git a/node_modules/@kwsites/promise-deferred/dist/index.d.ts b/node_modules/@kwsites/promise-deferred/dist/index.d.ts
deleted file mode 100644
index 68fb38a..0000000
--- a/node_modules/@kwsites/promise-deferred/dist/index.d.ts
+++ /dev/null
@@ -1,49 +0,0 @@
-/**
- * The `DeferredPromise` has a `promise` property in an initially pending state,
- * that will be resolved when the `done` method is called or rejected when the
- * `fail` method is called.
- */
-export interface DeferredPromise<RESOLVES, REJECTS extends Error = Error> {
- done(result: RESOLVES): void;
- fail(error: REJECTS): void;
- readonly status: DeferredPromiseStatus;
- readonly fulfilled: boolean;
- promise: Promise<RESOLVES>;
-}
-/**
- * The three states the DeferredPromise can be in - initially pending then either
- * resolved or rejected when it is fulfilled.
- *
- * ```typescript
- import {createDeferred, DeferredPromiseStatus} from '@kwsites/promise-deferred`;
-
- const pending: DeferredPromiseStatus = 'pending';
- expect(createDeferred()).toHaveProperty('status', pending);
- ```
- */
-export declare type DeferredPromiseStatus = 'pending' | 'resolved' | 'rejected';
-/**
- * Creates a new `DeferredPromise`
- *
- * ```typescript
- import {deferred} from '@kwsites/promise-deferred`;
- ```
- */
-export declare function deferred<T extends any = void, E extends Error = Error>(): DeferredPromise<T, E>;
-/**
- * Alias of the exported `deferred` function, to help consumers wanting to use `deferred` as the
- * local variable name rather than the factory import name, without needing to rename on import.
- *
- * ```typescript
- import {createDeferred} from '@kwsites/promise-deferred`;
- ```
- */
-export declare const createDeferred: typeof deferred;
-/**
- * Default export allows use as:
- *
- * ```typescript
- import deferred from '@kwsites/promise-deferred`;
- ```
- */
-export default deferred;