Module src/core/promise

Index

References

Functions

References

ControllablePromise

Re-exports ControllablePromise

ControllablePromiseConstructor

Re-exports ControllablePromiseConstructor

ControllablePromiseExecutor

Re-exports ControllablePromiseExecutor

ControllablePromiseRejectHandler

Re-exports ControllablePromiseRejectHandler

ControllablePromiseResolveHandler

Re-exports ControllablePromiseResolveHandler

CreateControllablePromiseOptions

Re-exports CreateControllablePromiseOptions

Functions

createControllablePromise

createControllablePromise<T>(opts: CreateControllablePromiseOptions<T>): ControllablePromise<T extends new (...args: any[]) => infer R ? R : Promise<unknown>>
createControllablePromise<T>(opts?: CreateControllablePromiseOptions<PromiseConstructor>): ControllablePromise<Promise<T>>

- Defined in src/core/promise/index.ts:46
Creates a promise that can be resolved from the "outside"
example
```
const promise = createControllablePromise();
promise.resolve(10);
```
Type parameters
- T: ControllablePromiseConstructor<unknown, T>
  
  promise constructor
Parameters
- opts: CreateControllablePromiseOptions<T>
  
  additional options
Returns ControllablePromise<T extends new (...args: any[]) => infer R ? R : Promise<unknown>>
- Defined in src/core/promise/index.ts:56
Creates a promise that can be resolved from the "outside"

Type parameters
- T = unknown
  
  type of the resolved promise value
Parameters
- Optional opts: CreateControllablePromiseOptions<PromiseConstructor>
Returns ControllablePromise<Promise<T>>

isControllablePromise

isControllablePromise<T>(promise: T): promise is ControllablePromise<T>
isControllablePromise(obj: unknown): obj is ControllablePromise<PromiseLike<unknown>>

- Defined in src/core/promise/index.ts:23
Returns true if the specified promise implements the interface of ControllablePromise

Type parameters
- T: PromiseLike<any, T>
Parameters
- promise: T
Returns promise is ControllablePromise<T>
- Defined in src/core/promise/index.ts:29
Returns true if the specified object implements the interface of ControllablePromise

Parameters
- obj: unknown
Returns obj is ControllablePromise<PromiseLike<unknown>>