maybeSecretUuid

​

Function Signature

async function maybeSecretUuid(
  key: string
): Promise<UUID | 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 validates it as a UUID
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 UUID

​

Difference from secretUuid

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

​

Example

import { maybeSecretUuid } from "@nore/load-env"
import type { UUID } from "node:crypto"

// Returns undefined if the secret doesn't exist
const API_TOKEN = await maybeSecretUuid("API_TOKEN")

if (API_TOKEN) {
  console.log(`Using API token: ${API_TOKEN}`)
  // Make authenticated requests
} else {
  console.log("No API token found, using anonymous access")
  // Make unauthenticated requests
}

​

Secret File Format

123e4567-e89b-12d3-a456-426614174000

​

Error Handling

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

• The file exists but the value is not a valid UUID format