secretUrl

​

Function Signature

async function secretUrl(
  key: string,
  fallback?: URL
): Promise<URL>

​

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 URL using the URL constructor
4. Throws an error if the secret is missing or invalid (unless a fallback is provided)

​

Example

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

// Reads from file path in $API_URL or /run/secrets/API_URL
export const API_URL = await secretUrl("API_URL")

// With fallback
export const DATABASE_URL = await secretUrl(
  "DATABASE_URL",
  new URL("postgres://localhost:5432/dev")
)

// Use the URL
const response = await fetch(API_URL)

​

Secret File Format

https://api.example.com

postgres://user:password@host:5432/database

​

Error Handling

• The secret file doesn’t exist (when no fallback provided)
• The file is empty (when no fallback provided)
• The value is not a valid URL