Interface EnvVarSpec

Specification of one environment variable for IEnvironmentApi.validate.

Since

0.1.0

interface EnvVarSpec {
    default?: string | number | boolean;
    required?: boolean;
    type?: "string" | "number" | "boolean";
}

Index

Properties

default? required? type?

Properties

`Optional` `Readonly`default

default?: string | number | boolean

Default applied when the variable is absent.

`Optional` `Readonly`required

required?: boolean

Whether the variable must be present.

`Optional` `Readonly`type

type?: "string" | "number" | "boolean"

Expected primitive type (defaults to 'string').