Class ComputedKey<T, K, D, Sync, P>Abstract

A key that transforms a provider for K into a provider of T.

Not meant to be extended by library consumers. Instead, use the implementations provided in Inject.

Type Parameters

Hierarchy

  • AbstractKey
    • ComputedKey

Implements

  • HasComputedKeySymbol<T, D, Sync>

Constructors

Properties

Methods

DependencyKey Operators

Constructors

  • Type Parameters

    • T = any

    • K extends DependencyKey = any

    • D = any

    • Sync = any

    • P extends ProvideGraph = any

    Returns ComputedKey<T, K, D, Sync, P>

Properties

inner: K

This key determines the dependencies that will be passed to this.init().

Methods

DependencyKey Operators

  • Resolves to a Promise of the target value, allowing a synchronous resource to depend on an asynchronous one.

    Type Parameters

    Parameters

    • this: Th

    Returns Async<Th>

    See

    async

  • Applicable when this is a key that resolves to a function, for example a SubcomponentDefinition or a FactoryKey. Resolves to the output of the function when called with args.

    class UserFactory extends FactoryKey(
    (name: string, id: number) => new User(name, id),
    ) { private _: any }

    container.inject({ user: UserFactory.Build(name, id) }, ({ user }) => {
    console.log(user.name, user.id)
    })

    Type Parameters

    • Th extends SimpleKey<((...args) => Out)>

    • Args extends any[]

    • Out = Th extends SimpleKey<((...args) => O)>
          ? O
          : never

    Parameters

    • this: Th
    • Rest ...args: Args

    Returns Build<Th, Args, Out>

    See

    build

  • Applies the given transform to the resolved value of this DependencyKey.

    Type Parameters

    Parameters

    • this: Th
    • transform: ((x) => U)
        • (x): U
        • Parameters

          Returns U

    Returns Map<U, Th, P>

    Example

    class IdNum extends TypeKey<number>() { private _: any }
    class IdStr extends TypeKey({
    default: IdNum.Map(id => id.toString()),
    }) { private _: any }

    See

    map

  • Requests a value for this key, without compile-time verification of dependencies. An exception will be thrown if the dependency is not available upon request.

    Static verification that this key can be resolved synchronously is still performed.

    Type Parameters

    Parameters

    • this: Th

    Returns Unchecked<Th>

Generated using TypeDoc