locale-codes v1.3.1

Locale Codes

Language codes & country codes

Installation

Module available through the npm registry. It can be installed using the npm or yarn command line tool.

# Yarn (Recomend)
yarn add locale-codes
# NPM 
npm install locale-codes --save

Examples

JavaScript

/* eslint-disable no-unused-expressions */
const locale = require('locale-codes')

locale.all // [language: '...']
locale.getByTag('pt-br').name // 'Portuguese'
locale.where('tag', 'pt-br').name // 'Portuguese'

TypeScript

/* eslint-disable @typescript-eslint/no-unused-expressions, @typescript-eslint/no-unused-vars */
import * as locale from 'locale-codes'
import {ILocale} from '.'

locale.all // [language: '...']
const localeSelect: ILocale = locale.all[0]

locale.getByTag('pt-br').name // 'Portuguese'
locale.where('tag', 'pt-br').name // 'Portuguese'

Documentation

API

locale.all

All languages

locale.where(key, text)

Get information

• name - Language name (String)
• name - Language name local (String || Null)
• location - Location country (String || Null)
• tag - LCID tag (String)
• lcid - LCID id (Number)
• iso639-2 - ISO 639-2 id (String)
• iso639-1 - ISO 639-1 id (String || Null)

Shortcuts

• getByName(text) = where('name', text)
• getByNameLocal(text) = where('local', text)
• getByLocation(text) = where('location', text)
• getByTag(text) = where('tag', text)
• getByLCID(lcid) = where('lcid', id)
• getByISO6392(text) = where('iso639-2', text)
• getByISO6391(text) = where('iso639-1', text)

Locale List

Tests

To run the test suite, first install the dependencies, then run test:

# Using Yarn
yarn test

Dependencies

Dev Dependencies

Contributors

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue. List of all contributors.

License

MIT © Tiago Danin