subtag

Language tag parser. Parse language tags into subtags.

api

• subtag(tag) parse tag into subtags object
• subtag.split(tag) split tag into subtags array
• subtag.language(tag) get primary language subtag
• subtag.extlang(tag) get extended language subtag
• subtag.script(tag) get script subtag
• subtag.region(tag) get region subtag

notes

• parsing is done via regex
• unpresent subtags will be an empty string
• separator can be dashes (standard) or underscores

setup

install via npm or yarn

npm install subtag --save

yarn add subtag

usage

require usage

1var subtag = require('subtag')

import usage

1import subtag from 'subtag'

examples

objects

1subtag('ja-JP') // {language: 'ja', extlang: '', script: '', region: 'JP'}
2subtag('es-AR') // {language: 'es', extlang: '', script: '', region: 'AR'}

arrays

1subtag.split('yue') // ["yue"]
2subtag.split('es-419') // ["es", "419"]
3subtag.split('zh-Hant-HK') // ["zh", "Hant", "HK"]
4subtag.split('en-90210') // ["en"] because 90210 is fake

subtags

1subtag.language('en') // 'en'
2subtag.extlang('en') // ''
3subtag.script('en') // ''
4subtag.region('en') // ''
5
6subtag.language('en-US') // 'en'
7subtag.extlang('en-US') // ''
8subtag.script('en-US') // ''
9subtag.region('en-US') // 'US'
10
11subtag.language('zh-yue') // 'zh'
12subtag.extlang('zh-yue') // 'yue'
13subtag.script('zh-yue') // ''
14subtag.region('zh-yue') // ''
15
16subtag.language('zh-Hans') // 'zh'
17subtag.extlang('zh-Hans') // ''
18subtag.script('zh-Hans') // 'Hans'
19subtag.region('zh-Hans') // ''

structure

language-extlang-script-region-variant-extension-privateuse

type	pattern	convention
language	2-letter or 3-letter	lowercase
extlang	3-letter	lowercase
script	4-letter	titlecase
region	2-letter or 3-number	uppercase

.pattern

Regex patterns are exposed for validation

1subtag.language.pattern.test('en') // true
2subtag.language.pattern.test('ast') // true
3subtag.language.pattern.test('fake') // false
4subtag.extlang.pattern.test('yue') // true
5subtag.script.pattern.test('Hans') // true
6subtag.region.pattern.test('US') // true
7subtag.region.pattern.test('005') // true
8subtag.region.pattern.test('90210') // false

compatibility

Works in Node.js and ES5+ browsers