Interface PromisorFactory

Helper methods for creating and chaining Promisors used for Contracts.bind().

interface PromisorFactory {
    createExtractor<T, R>(
        promisor: PromisorType<T>,
        extractor: TransformType<T, R>,
    ): Promisor<R>;
    createLifeCycle<T>(promisor: PromisorType<T>): Promisor<T>;
    createSingleton<T>(promisor: PromisorType<T>): Promisor<T>;
    createValue<T>(deliverable: OptionalType<T>): Promisor<T>;
}

Index

Methods

createExtractor createLifeCycle createSingleton createValue

Methods

createExtractor

createExtractor<T, R>(
promisor: PromisorType<T>,
extractor: TransformType<T, R>,
): Promisor<R>
Extract values from the deliverable of a source Promisor. Note: increment and decrementUsage are relayed to the source promisor.
Type Parameters
- T
  the type of deliverable
- R
  the new Promisor deliverable type
Parameters
- promisor: PromisorType<T>
  the source promisor
- extractor: TransformType<T, R>
  the function that gets an object from the deliverable. For example Person => Age
Returns Promisor<R>
the new Promisor
- Defined in src/api/PromisorFactory.ts:51

createLifeCycle

createLifeCycle<T>(promisor: PromisorType<T>): Promisor<T>
Reference counted, lazy loaded, with opt-in 'open' and 'close' invoked on deliverable. Note: increment and decrementUsage are relayed to the source promisor.
Type Parameters
- T
  the type of deliverable
Parameters
- promisor: PromisorType<T>
  the source promisor
Returns Promisor<T>
the new Promisor
- Defined in src/api/PromisorFactory.ts:39

createSingleton

createSingleton<T>(promisor: PromisorType<T>): Promisor<T>
Creates a Promisor that only calls the source Promisor once and then always returns that value. Note: increment and decrementUsage are relayed to the source promisor.
Type Parameters
- T
  the type of deliverable
Parameters
- promisor: PromisorType<T>
  the source Promisor
Returns Promisor<T>
The new Promisor
- Defined in src/api/PromisorFactory.ts:29

createValue

createValue<T>(deliverable: OptionalType<T>): Promisor<T>
Creates a Promisor that returns the given value every time it is claimed.
Type Parameters
- T
  the type of deliverable
Parameters
- deliverable: OptionalType<T>
  the value to
Returns Promisor<T>
The new Promisor
- Defined in src/api/PromisorFactory.ts:18