createEnvironment
function createEnvironment<Schema>(schema, loadEnvironmentConfig?): object;Defined in: index.ts:6
Type Parameters
Section titled “Type Parameters”Schema
Section titled “Schema”Schema extends StandardSchemaV1<unknown, unknown>
Parameters
Section titled “Parameters”schema
Section titled “schema”Schema
loadEnvironmentConfig?
Section titled “loadEnvironmentConfig?”true | DotenvConfigOptions
Returns
Section titled “Returns”object
loadEnv
Section titled “loadEnv”loadEnv: (options?) => DotenvConfigOutput = loadEnvironment;Parameters
Section titled “Parameters”options?
Section titled “options?”DotenvConfigOptions
Returns
Section titled “Returns”DotenvConfigOutput
schema
Section titled “schema”schema: Schema;generateExample()
Section titled “generateExample()”generateExample(path): Promise<void>;Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
validate()
Section titled “validate()”validate(__namedParameters?): Promise<InferOutput<Schema>>;Parameters
Section titled “Parameters”__namedParameters?
Section titled “__namedParameters?”Record<string, undefined | string> = process.env
Returns
Section titled “Returns”Promise<InferOutput<Schema>>