env
- Environment Variable Access
- Type:
(key: string) => string
- Description: The
env
function provides secure access to environment variables. It returns an empty string if the variable is not found.
Basic Usage
const apiKey = env('API_KEY')
const dbPassword = env('DB_PASSWORD')
Template Usage
<% const apiKey = env('API_KEY') %>
<p>Using API key: <%= apiKey %></p>
Security Notes
- Returns empty string for undefined variables
- Use for sensitive configuration
- Avoid exposing secrets in templates
- Prefer environment variables over hardcoded values
Best Practices
- Check for Required Variables
const apiKey = env('API_KEY')
if (!apiKey) {
error('Missing required API_KEY environment variable')
// Handle error case
}
- Use Descriptive Names
// Good
const stripeSecretKey = env('STRIPE_SECRET_KEY')
// Avoid
const key = env('KEY')
- Document Required Variables
// Document required environment variables in your README or configuration files
/**
* Required environment variables:
* - API_KEY: Your API key for external service
* - DB_PASSWORD: Database password
* - SMTP_PASSWORD: Email service password
*/