iso-639-1-plus's Introduction

ISO-639-1-plus

Simple interface for ISO-639-1 2-letter language codes and common IETF BCP 47 language tags.

Forked from iso-639-1 and extended with a some common language subtags for regional variations (eg. en-GB, pt-BR, zh-Hans). The intention is not to provide a definitive list, but a subset of commonly used language tags / locales.

Installation

npm install iso-639-1-plus

Usage

Node.js

const ISO6391 = require('iso-639-1-plus');
console.log(ISO6391.getName('en-GB')); // 'English (UK)'

ES Module

import ISO6391 from 'iso-639-1-plus';
console.log(ISO6391.getName('en-GB')); // 'English (UK)'

Browsers

HTML

<script type="text/javascript" src="./node_modules/iso-639-1-plus/build/index.js"></script>

Visit global variable ISO6391 in js

console.log(ISO6391.getName('en-GB')); // 'English (UK)'

Methods

getName(code)

@param code {string}
@return {string}

Lookup language English name by code

getAllNames()

@return {array}

Get array of all language English names

getNativeName(code)

@param code {string}
@return {string}

Lookup language native name by code

getAllNativeNames()

@return {array}

Get array of all language native names

getCode(name)

@param name {string}
@return {string}

Lookup code by English name or native name

getAllCodes()

@return {array}

Get array of all codes

validate(code)

@param code {string}
@return {boolean}

Check whether the given code is in the list of ISO-639-1

getLanguages(codes)

@param codes {array}
@return {array}

Get the array of the language objects by the given codes

Example

const ISO6391 = require('iso-639-1-plus')

console.log(ISO6391.getName('zh')) // 'Chinese'
console.log(ISO6391.getNativeName('zh')) // '中文'

console.log(ISO6391.getAllNames()) // ['Afar','Abkhaz', ... ,'Zulu']
console.log(ISO6391.getAllNativeNames()) //['Afaraf','аҧсуа бызшәа', ... ,'isiZulu' ]

console.log(ISO6391.getCode('Chinese')) // 'zh'
console.log(ISO6391.getCode('中文')) // 'zh'

console.log(ISO6391.getAllCodes()) //['aa','ab',...,'zu']

console.log(ISO6391.validate('en')) // true
console.log(ISO6391.validate('xx')) // false

console.log(ISO6391.getLanguages(['en', 'zh']))
// [{code:'en',name:'English',nativeName:'English'},{code:'zh',name:'Chinese',nativeName:'中文'}]

iso-639-1-plus's People

Contributors

Stargazers

Watchers

iso-639-1-plus's Issues

The package is still broken because build was not rebuilt

https://npmfs.com/compare/iso-639-1-plus/3.0.1/3.0.2/

As you can see here the fix did not go into build/

but Node.js imports from iso-639-1-plus\build\index.js

To avoid this situation in the future I recommend:

Remove build/ artifact from git (to avoid polluting the commits with double changes)
Add a npm publish hook to build just before publish automatically (to avoid forgetting to build)
specify what exact files go to npm publish (src and build) (eslintrc and .vscode should not be in npm)