Class EnvironmentRegistry<Env>

environments

addEnv

• addEnv<
      EnvName extends string,
      EnvData,
      R extends Resolution<string, EnvData, any, AsyncStatus>,
  >(
      envName: RemoveLiteral<EnvName, Env["name"]>,
      _envDataType: TypeDef<EnvData>,
      f: (
          env: Environment<EnvName, EnvData, never>,
      ) => Environment<EnvName, EnvData, R>,
  ): EnvironmentRegistry<Env | Environment<EnvName, EnvData, R>>

  Adds a new environment to the registry.

  This method ensures type safety by preventing duplicate environment names and maintaining the union type of all environments.

  Type Parameters

  • EnvName extends string

    The name of the environment (must be unique)
  • EnvData

    The data structure for this environment
  • R extends Resolution<string, EnvData, any, AsyncStatus>

    The union of all resolution types for this environment

  Parameters

  • envName: RemoveLiteral<EnvName, Env["name"]>

    The unique name for this environment
  • _envDataType: TypeDef<EnvData>

    Type definition for the environment data (used for type inference)
  • f: (env: Environment<EnvName, EnvData, never>) => Environment<EnvName, EnvData, R>

    Function that configures the environment with its resolutions

  Returns EnvironmentRegistry<Env | Environment<EnvName, EnvData, R>>

  A new EnvironmentRegistry with the added environment

  Example

  const envReg = createEnvironmentRegistry()
    .addEnv("local", defineType<{ env: Record<string, string> }>(), (env) => env
      .addResolution("hardcoded", defineType<string>(), (data) => data.payload)
      .addResolution("from-env", defineType<undefined>(), (data) =>
        data.envData.env[data.variableName]))
  Copy

Staticcreate

• create(): EnvironmentRegistry<never>
  Internal

  Creates a new empty EnvironmentRegistry.

  Returns EnvironmentRegistry<never>

  A new EnvironmentRegistry with no environments

  Example

  const envReg = EnvironmentRegistry.create()
  Copy

createVariableRegistry

• createVariableRegistry(): VariableRegistry<EnvironmentRegistry<Env>, never>

  Creates a VariableRegistry that can define variables for this environment registry.

  The VariableRegistry will have full type safety for all environments and resolutions defined in this registry.

  Returns VariableRegistry<EnvironmentRegistry<Env>, never>

  A new VariableRegistry configured for this environment registry

  Example

  const varReg = envReg.createVariableRegistry()
    .addVar("DATABASE_URL", (v) => v
      .for("local", "from-env")
      .for("workflows", "from-github-secrets"))
  Copy