Overview

The isValidLocale function checks whether a given string is a valid BCP‑47 locale code. It performs comprehensive format validation without requiring a GT class instance.

Reference

Parameters

Returns

boolean — true if the locale code is valid, false otherwise

Examples

import { isValidLocale } from 'generaltranslation';

// Valid locale codes
console.log(isValidLocale('en-US')); // true
console.log(isValidLocale('zh-CN')); // true
console.log(isValidLocale('es')); // true

// Invalid locale codes
console.log(isValidLocale('invalid')); // false
console.log(isValidLocale('en_US')); // false (underscore instead of hyphen)
console.log(isValidLocale('')); // false

Notes

• Validates BCP‑47 locale code format
• Works with custom locale mappings
• Essential for user input validation
• No network requests — purely format validation
• Stateless function suitable for utility libraries

Next steps

• Use the GT class method isValidLocale
• Standardise the format with standardizeLocale