envFloat

​

Signature

function envFloat(key: string, fallback?: number): number

​

Parameters

​

Returns

​

Behavior

• Reads the environment variable and trims whitespace
• Falls back to the string representation of the fallback number if the variable is not set
• Throws an error if both the variable and fallback are missing
• Parses the string value using parseFloat()
• Allows values like 0 (falsy but valid numbers)
• Throws a TypeError if the value cannot be parsed as a number (results in NaN)

​

Error Handling

• Throws Error with message "$KEY is missing" when the environment variable is not set and no fallback is provided
• Throws TypeError with message "$KEY is not a number: VALUE" when the value cannot be parsed as a number

​

Example

import { envFloat } from "@natoboram/load_env"

// With fallback
export const ZOOM = envFloat("ZOOM", 1.0)

// Without fallback (will throw if not set)
export const GOLDEN_RATIO = envFloat("GOLDEN_RATIO")

// Using Math.sqrt for fallback
const phi = (1 + Math.sqrt(5)) / 2
export const PHI = envFloat("PHI", phi)

// Usage examples:
// ZOOM=1.618033988749895 → 1.618033988749895
// ZOOM=0 → 0 (valid)
// ZOOM=3.14 → 3.14
// ZOOM not set → 1.0 (uses fallback)