promises | @pagopa/ts-commons

Index

Functions

Functions

DeferredPromise

DeferredPromise<T>(): ITuple3<Promise<T>, (v: T) => void, (e: Error) => void>

- Defined in src/promises.ts:42
Creates a Promise whose resolve and reject implementations are not yet provided.

Type parameters
- T
Returns ITuple3<Promise<T>, (v: T) => void, (e: Error) => void>

Array A triplet with [Promise, resolve(T), reject()]

timeoutPromise

timeoutPromise(millis: Millisecond): Promise<void>

- Defined in src/promises.ts:12
Returns a Promise that resolves after millis milliseconds

Parameters
- millis: Millisecond
Returns Promise<void>

withTimeout

withTimeout<T>(p: Promise<T>, millis: Millisecond, timeoutP?: (_: Millisecond) => Promise<void>): Promise<Either<"timeout", T>>

- Defined in src/promises.ts:22
Wraps a Promise with a timeout, resolves to Left<"timeout"> on timeout or Right on completion.

Type parameters
- T
Parameters
- p: Promise<T>
- millis: Millisecond
- timeoutP: (_: Millisecond) => Promise<void> = ...
  - - (_: Millisecond): Promise<void>
    - Parameters
      - _: Millisecond
      Returns Promise<void>
Returns Promise<Either<"timeout", T>>

Generated using TypeDoc