Class Environment<Name, Data, R>

dataType

name

resolutions

Staticcreate

• create<Name extends string, Data>(name: Name): Environment<Name, Data, never>
  Internal

  Creates a new Environment with the specified name and data type.

  Type Parameters

  • Name extends string

    The name of the environment
  • Data

    The data structure for this environment

  Parameters

  • name: Name

    The name of the environment

  Returns Environment<Name, Data, never>

  A new Environment with no resolutions

addResolution

• addResolution<Tag extends string, Payload>(
      tag: RemoveLiteral<Tag, R["tag"]>,
      _payloadType: TypeDef<Payload>,
      resolve: Resolve<Data, Payload, "sync">,
  ): Environment<Name, Data, R | Resolution<Tag, Data, Payload, "sync">>

  Adds a synchronous resolution method to the environment.

  Type Parameters

  • Tag extends string

    The unique tag for this resolution method
  • Payload

    The payload type for this resolution

  Parameters

  • tag: RemoveLiteral<Tag, R["tag"]>

    The unique tag for this resolution method
  • _payloadType: TypeDef<Payload>

    Type definition for the payload (used for type inference)
  • resolve: Resolve<Data, Payload, "sync">

    The synchronous resolve function

  Returns Environment<Name, Data, R | Resolution<Tag, Data, Payload, "sync">>

  A new Environment with the added resolution

  Example

  (env) => env
    .addResolution("hardcoded", defineType<string>(), (data) => data.payload)
    .addResolution("from-env", defineType<undefined>(), (data) =>
      data.envData.env[data.payload ?? data.variableName])
  Copy

• addResolution<Tag extends string, Payload>(
      tag: Tag,
      _payloadType: TypeDef<Payload>,
      resolve: Resolve<Data, Payload, "async">,
  ): Environment<Name, Data, R | Resolution<Tag, Data, Payload, "async">>

  Adds an asynchronous resolution method to the environment.

  Type Parameters

  • Tag extends string

    The unique tag for this resolution method
  • Payload

    The payload type for this resolution

  Parameters

  • tag: Tag

    The unique tag for this resolution method
  • _payloadType: TypeDef<Payload>

    Type definition for the payload (used for type inference)
  • resolve: Resolve<Data, Payload, "async">

    The asynchronous resolve function

  Returns Environment<Name, Data, R | Resolution<Tag, Data, Payload, "async">>

  A new Environment with the added resolution

  Example

  (env) => env
    .addResolution("from-aws-secrets", defineType<undefined>(), async (data) => {
      await new Promise(resolve => setTimeout(resolve, 1000))
      return `secret for ${data.variableName} from aws`
    })
  Copy