locale.ts

/**
 * @file Locale and language environment variable getters. Provides access to
 *   system locale settings.
 */

import { getEnvValue } from './rewire'

/**
 * LANG environment variable. System locale and language settings.
 *
 * @example
 *   ;```typescript
 *   import { getLang } from '@socketsecurity/lib/env/locale'
 *
 *   const lang = getLang()
 *   // e.g. 'en_US.UTF-8' or undefined
 *   ```
 *
 * @returns The system locale string, or `undefined` if not set
 */
export function getLang(): string | undefined {
  return getEnvValue('LANG')
}

/**
 * LC_ALL environment variable. Override for all locale settings.
 *
 * @example
 *   ;```typescript
 *   import { getLcAll } from '@socketsecurity/lib/env/locale'
 *
 *   const lcAll = getLcAll()
 *   // e.g. 'C' or 'en_US.UTF-8'
 *   ```
 *
 * @returns The locale override string, or `undefined` if not set
 */
export function getLcAll(): string | undefined {
  return getEnvValue('LC_ALL')
}

/**
 * LC_MESSAGES environment variable. Locale setting for message translations.
 *
 * @example
 *   ;```typescript
 *   import { getLcMessages } from '@socketsecurity/lib/env/locale'
 *
 *   const lcMessages = getLcMessages()
 *   // e.g. 'en_US.UTF-8' or undefined
 *   ```
 *
 * @returns The messages locale string, or `undefined` if not set
 */
export function getLcMessages(): string | undefined {
  return getEnvValue('LC_MESSAGES')
}