Documentation

Documentation / zerotal / helpers / env

Function: env()

Call Signature

env(key): string | undefined

Defined in: packages/core/src/helpers/index.ts:100

Read an environment variable with an optional typed fallback.

Parameters

key

string

Returns

string | undefined

Example

env('APP_NAME', 'Zerotal App')   // string
env('APP_DEBUG', false)        // boolean (coerces 'true'/'false' strings)
env('PORT', 3000)              // number  (coerces numeric strings)
env('APP_KEY')                 // string | undefined — no fallback

Call Signature

env(key, fallback): string

Defined in: packages/core/src/helpers/index.ts:101

Read an environment variable with an optional typed fallback.

Parameters

key

string

fallback

string

Returns

string

Example

env('APP_NAME', 'Zerotal App')   // string
env('APP_DEBUG', false)        // boolean (coerces 'true'/'false' strings)
env('PORT', 3000)              // number  (coerces numeric strings)
env('APP_KEY')                 // string | undefined — no fallback

Call Signature

env(key, fallback): boolean

Defined in: packages/core/src/helpers/index.ts:102

Read an environment variable with an optional typed fallback.

Parameters

key

string

fallback

boolean

Returns

boolean

Example

env('APP_NAME', 'Zerotal App')   // string
env('APP_DEBUG', false)        // boolean (coerces 'true'/'false' strings)
env('PORT', 3000)              // number  (coerces numeric strings)
env('APP_KEY')                 // string | undefined — no fallback

Call Signature

env(key, fallback): number

Defined in: packages/core/src/helpers/index.ts:103

Read an environment variable with an optional typed fallback.

Parameters

key

string

fallback

number

Returns

number

Example

env('APP_NAME', 'Zerotal App')   // string
env('APP_DEBUG', false)        // boolean (coerces 'true'/'false' strings)
env('PORT', 3000)              // number  (coerces numeric strings)
env('APP_KEY')                 // string | undefined — no fallback