maybeSecretBool

​

Function Signature

async function maybeSecretBool(
  key: string
): Promise<boolean | undefined>

​

Parameters

​

Returns

​

How It Works

1. Checks if the environment variable key contains a file path
2. If no path is set, defaults to /run/secrets/{key}
3. Reads the file contents and parses it as a boolean
4. Returns undefined if the secret file doesn’t exist (instead of throwing)
5. Still throws an error if the file exists but contains an invalid boolean value

​

Difference from secretBool

• maybeSecretBool: Returns undefined when the secret file is missing
• secretBool: Throws an error when the secret file is missing (unless a fallback is provided)

​

Example

import { maybeSecretBool } from "@nore/load-env"

// Returns undefined if the secret doesn't exist
export const FEATURE_FLAG = await maybeSecretBool("FEATURE_FLAG")

if (FEATURE_FLAG) {
  console.log("Feature is enabled")
} else if (FEATURE_FLAG === false) {
  console.log("Feature is explicitly disabled")
} else {
  console.log("Feature flag not configured")
}

​

Error Handling

• The secret file doesn’t exist
• The file is empty

• The file exists but cannot be parsed as a boolean