@byu-trg/language-code-service v2.0.0

Language Code Service

Library for interfacing with the IANA Language Subtag Registry.

The IANA Language Subtag Registry is not fetched in real time and is instead cached within the library upon every release.

Types

interface IANALanguage {
  tag: string,
  description: string
}

interface Subtags {
  primary: string;
  extended: string[];
}

class Language {
  readonly subtags: Subtags;
  readonly description: string;
  get tag(): string;
}

Methods

/** 
 * Retrieves all languages from the IANA Language Subtag Registry.
 */
getAllLanguages(): IANALanguage[]

/** 
 * Retrieves a language using a provided language tag. 
 * 
 * The primary subtag of the provided language tag will be used to query the IANA Language Subtag Registry. 
 * Extended subtags will be derived from the provided language tag.
 *
 * Errors will be thrown if the provided language tag does not follow BCP 47 format or if its primary subtag does not exist in the IANA Language Subtag Registry.
 */
getLanguage = (langTag: string): Language