The bcp-47 npm package is used for parsing, validating, and manipulating BCP 47 language tags. BCP 47 is a standard for language tags that are used to identify human languages in a standardized way.
Parsing BCP 47 Language Tags
This feature allows you to parse a BCP 47 language tag into its components. For example, 'en-US' would be parsed into an object representing the language 'English' and the region 'United States'.
const bcp47 = require('bcp-47');
const parsedTag = bcp47.parse('en-US');
console.log(parsedTag);Validating BCP 47 Language Tags
This feature allows you to validate whether a given string is a valid BCP 47 language tag. For example, 'en-US' would return true, indicating it is a valid tag.
const bcp47 = require('bcp-47');
const isValid = bcp47.validate('en-US');
console.log(isValid);Formatting BCP 47 Language Tags
This feature allows you to format an object representing a BCP 47 language tag back into a string. For example, an object with language 'en' and region 'US' would be formatted back into 'en-US'.
const bcp47 = require('bcp-47');
const formattedTag = bcp47.stringify({ language: 'en', region: 'US' });
console.log(formattedTag);The language-tags package provides similar functionality for parsing, validating, and manipulating BCP 47 language tags. It offers a more comprehensive set of features, including support for extensions and private use tags.
The locale package focuses on parsing and validating locale identifiers, which include language tags as part of their structure. It provides additional functionality for handling locale-specific data and formatting.
The cldr-core package provides data and utilities for working with the Unicode Common Locale Data Repository (CLDR), which includes BCP 47 language tags. It offers a broader set of features for internationalization and localization.
Parse and stringify BCP 47 language tags.
This is a package that can parse BCP 47 language tags to an object representing them, and serialize those objects back into language tags. It supports a forgiving mode to handle incorrect BCP 47 tags and can emit warnings about problems in incorrect tags.
You can use this package if you need to access the data stored in BCP 47 language tags. You can also use this package if you want to check (lint) or manipulate tags.
This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:
npm install bcp-47
In Deno with Skypack:
import * as bcp47 from 'https://cdn.skypack.dev/bcp-47@2?dts'
In browsers with Skypack:
<script type="module">
import * as bcp47 from 'https://cdn.skypack.dev/bcp-47@2?min'
</script>
import {parse, stringify} from 'bcp-47'
const schema = parse('hy-Latn-IT-arevela')
console.log(schema)
console.log(stringify(schema))
Yields:
{ language: 'hy',
extendedLanguageSubtags: [],
script: 'Latn',
region: 'IT',
variants: ['arevela'],
extensions: [],
privateuse: [],
irregular: null,
regular: null }
'hy-Latn-IT-arevela'
This package exports the following identifiers: parse and stringify.
There is no default export.
parse(tag[, options])Parse a BCP 47 tag into a language schema. Note that the algorithm is case insensitive.
options.normalizeWhether to normalize legacy tags when possible (boolean, default:
true).
For example, i-klingon does not match the BCP 47 language algorithm but is
considered valid by BCP 47 nonetheless.
It is suggested to use tlh instead (the ISO 639-3 code for Klingon).
When normalize is true, passing i-klingon or other deprecated tags, is
handled as if their suggested valid tag was given instead.
options.forgivingBy default, when an error is encountered, an empty object is returned.
When in forgiving mode, all found values up to the point of the error
are included (boolean, default: false).
So, for example, where by default en-GB-abcdefghi an empty object is returned
(as the language variant is too long), in forgiving mode the language of
schema is populated with en and the region is populated with GB.
options.warningWhen given, warning is called when an error is encountered
(Function).
Parsed BCP 47 language tag (Schema).
When tag is null or undefined.
stringify(schema)Compile a schema to a BCP 47 language tag.
BCP 47 language tag (string).
SchemaA schema represents a language tag.
A schema is deemed empty when it has neither language, irregular, regular,
nor privateuse (where an empty privateuse array is handled as no
privateuse as well).
schema.languageTwo or three character ISO 639 language code, four character reserved
language code, or 5 to 8 (inclusive) characters registered language subtag
(string).
For example, en (English) or cmn (Mandarin Chinese).
schema.extendedLanguageSubtagsSelected three-character ISO 639 codes(Array<string>), such as
yue in zh-yue-HK (Chinese, Cantonese, as used in Hong Kong SAR).
schema.scriptFour character ISO 15924 script code (string), such as Latn in
hy-Latn-IT-arevela (Eastern Armenian written in Latin script, as used in
Italy).
schema.regionTwo alphabetical character ISO 3166-1 code or three digit
UN M49 code (string).
For example, CN in cmn-Hans-CN (Mandarin Chinese, Simplified script, as used
in China) or 419 in es-419 (Spanish as used in Latin America and the
Caribbean).
schema.variants5 to 8 (inclusive) character language variants (Array<string>), such as
rozaj and biske in sl-rozaj-biske (San Giorgio dialect of Resian dialect
of Slovenian).
schema.extensionsList of extensions (Array<Object>), each an object containing a one character
singleton, and a list of extensions (string).
singleton cannot be x (case insensitive) and extensions must be between
two and eight (inclusive) characters.
For example, an extension would be u-co-phonebk in de-DE-u-co-phonebk
(German, as used in Germany, using German phonebook sort order), where u is
the singleton and co and phonebk are its extensions.
schema.privateuseList of private-use subtags (Array<string>), where each subtag must be between
one and eight (inclusive) characters.
schema.regularOne of the regular tags (string): tags that are seen as something different
by the algorithm.
Valid values are:
art-lojbancel-gaulishno-bokno-nynzh-guoyuzh-hakkazh-minzh-min-nanzh-xiangschema.irregularOne of the irregular tags (string): tags that are seen as invalid by the
algorithm).
Valid values are:
en-GB-oedi-amii-bnni-defaulti-enochiani-haki-klingoni-luxi-mingoi-navajoi-pwni-taoi-tayi-tsusgn-BE-FRsgn-BE-NLsgn-CH-DEfunction warning(reason, code, offset)Called when an error occurs.
reason (string)
— English reason for failurecode (number)
— code for failureoffset (number)
— index-based place where the error occurred in the tag| code | reason |
|---|---|
| 1 | Too long variant, expected at most 8 characters |
| 2 | Too long extension, expected at most 8 characters |
| 3 | Too many extended language subtags, expected at most 3 subtags |
| 4 | Empty extension, extensions must have at least 2 characters of content |
| 5 | Too long private-use area, expected at most 8 characters |
| 6 | Found superfluous content after tag |
This package is fully typed with TypeScript.
It exports additional Schema, Extension, Warning, and Options types that
model their respective interfaces.
This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. It also works in Deno and modern browsers.
This package is safe.
wooorm/bcp-47-match
— match BCP 47 language tags with language ranges per RFC 4647wooorm/bcp-47-normalize
— normalize, canonicalize, and format BCP 47 tagswooorm/iso-3166
— ISO 3166 codeswooorm/iso-639-2
— ISO 639-2 codeswooorm/iso-639-3
— ISO 639-3 codeswooorm/iso-15924
— ISO 15924 codeswooorm/un-m49
— UN M49 codesYes please! See How to Contribute to Open Source.
FAQs
Parse and stringify BCP 47 language tags
We found that bcp-47 demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Former RubyGems maintainers have launched The Gem Cooperative, a new community-run project aimed at rebuilding open governance in the Ruby ecosystem.
Security News
An opt-in lazy import keyword aims to speed up Python startups, especially CLIs, without the ecosystem-wide risks that sank PEP 690.
Security News
Socket CEO Feross Aboukhadijeh discusses the recent npm supply chain attacks on PodRocket, covering novel attack vectors and how developers can protect themselves.