ISO-639-1-dir

Simple interface for ISO-639-1 language their 2-letter codes, english names, native names and writing directions. Typescript friendly.

Installation

npm install iso-639-1-dir

yarn add iso-639-1-dir

Usage

ES Module

1import ISO6391 from 'iso-639-1-dir';
2
3const codes = ISO6391.getAllCodes();

CommonJs

1const ISO6391 = require('iso-639-1-dir');
2
3const codes = ISO6391.getAllCodes();

Interfaces & Types

Codes list: ISO-639-1

1
2type LanguageCode = "aa" | "ab" | "ae" | "af" | "ak" | "am" | "an" | "ar" | "as" | "av" | "ay" | "az" | "ba" | "be" | "bg" | "bi" | "bm" | "bn" | "bo" | "br" | "bs" | "ca" | "ce" | "ch" | "co" | "cr" | "cs" | ... 155 more ... | "zu"
3
4type LanguageName = "Afar" | "Abkhaz" | "Avestan" | "Afrikaans" | "Akan" | "Amharic" | "Aragonese" | "Arabic" | "Assamese" | "Avaric" | "Aymara" | "Azerbaijani" | "Bashkir" | "Belarusian" | "Bulgarian" | ... 167 more ... | "Zulu"
5
6type LanguageNativeName = "Afaraf" | "аҧсуа бызшәа" | "avesta" | "Afrikaans" | "Akan" | "አማርኛ" | "aragonés" | "اَلْعَرَبِيَّةُ" | "অসমীয়া" | "авар мацӀ" | "aymar aru" | "azərbaycan dili" | "башҡорт теле" | ... 168 more ... | "isiZulu"
7
8/**
9 * ltr - left to right
10 * rtl - right to left
11 * ttb - top to bottom
12 */
13type LanguageDir = 'ltr' | 'rtl' | 'ttb';
14
15interface Language {
16  name: LanguageName;
17  nativeName: LanguageNativeName;
18  dir: LanguageDir;
19  code: LanguageCode;
20}

Methods

1  /**
2   * Get the array of the language objects by the given codes.
3   * Invalid codes will be filtered out.
4   */
5  getLanguages(codes: LanguageCode[]): Language[]
6
7  /**
8   * Get the language object by the given code
9   */
10  getLanguage(code: LanguageCode): Language | undefined
11
12  /**
13   * Get language english name by the code
14   */
15  getName(code: LanguageCode): LanguageName | undefined
16
17  /**
18   * Get language writing direction by the code
19   */
20  getDir(code: LanguageCode): LanguageDir | undefined
21
22  /**
23   * Get all languages english names
24   */
25  getAllNames(): LanguageName[]
26
27  /**
28   * Get language native name by the code
29   */
30  getNativeName(code: LanguageCode): LanguageNativeName | undefined
31
32  /**
33   * Get all languages native names
34   */
35  getAllNativeNames(): LanguageNativeName[]
36
37  /**
38   * Get code of a language by english name or native name
39   */
40  getCode(name: string): LanguageCode | undefined
41
42  /**
43   * Get all languages codes
44   */
45  getAllCodes(): LanguageCode[]
46
47  /**
48  * Validate if language exists by the code
49  */
50  validate(code: string): code is LanguageCode