iso639-1

KO | EN

gitlite — search

#python #react #golang #rust #deep-learning #linux #awesome #cli #kubernetes #awesome-list #pytorch #ios #openai #open-source

(★ 9)

Type-safe ISO 639-1 language code (a.k.a. two-letter codes) for TypeScript

iso639-1 Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Type-safe [ISO 639-1] language code for TypeScript
==================================================

[![JSR][JSR badge]][JSR]
[![deno.land/x/iso639_1][Deno module badge]][Deno module]
[![MIT License][License badge]](https://raw.githubusercontent.com/dahlia/iso639-1/main/LICENSE)
[![GitHub Actions][GitHub Actions badge]][GitHub Actions]
[![Codecov][Codecov badge]][Codecov]

This library provides a set of functions to work with [ISO 639-1] language
codes, a.k.a. two-letter language codes, in very type-safe way.

Although it does not introduce any new runtime types, it provides
the [`LanguageCode`] type, which is a narrowed-down version of
the `string` type that contains only valid two-letter language codes
defined in the ISO 639-1.

There are three ways to narrow down the `string` type to the
[`LanguageCode`] type: [`isLanguageCode`], [`parseLanguageCode`],
and [`validateLanguageCode`].  The following example shows how to narrow
down a string value to the [`LanguageCode`] type:

~~~~ typescript
import { authoritativeLabels, isLanguageCode } from "@hongminhee/iso639-1";

const code: string | null = prompt("Enter a two-letter language code:");
if (isLanguageCode(code)) {
  // code is now narrowed down to LanguageCode
  console.log("The language you chose is", authoritativeLabels[code].en);
} else {
  console.error("Invalid language code:", code);
}
~~~~

For details, see the [API references][JSR].

[JSR badge]: https://jsr.io/badges/@hongminhee/iso639-1
[JSR]: https://jsr.io/@hongminhee/iso639-1
[Deno module badge]: https://shield.deno.dev/x/iso639_1
[Deno module]: https://deno.land/x/iso639_1
[License badge]: https://img.shields.io/github/license/dahlia/iso639-1
[GitHub Actions badge]: https://github.com/dahlia/iso639-1/actions/workflows/test.yaml/badge.svg
[GitHub Actions]: https://github.com/dahlia/iso639-1/actions/workflows/test.yaml
[Codecov badge]: https://codecov.io/gh/dahlia/iso639-1/graph/badge.svg
[Codecov]: https://codecov.io/gh/dahlia/iso639-1
[ISO 639-1]: https://id.loc.gov/vocabulary/iso639-1.html
[`LanguageCode`]: https://jsr.io/@hongminhee/iso639-1/doc/~/LanguageCode
[`isLanguageCode`]: https://jsr.io/@hongminhee/iso639-1/doc/~/isLanguageCode
[`parseLanguageCode`]: https://jsr.io/@hongminhee/iso639-1/doc/~/parseLanguageCode
[`validateLanguageCode`]: https://jsr.io/@hongminhee/iso639-1/doc/~/validateLanguageCode

iso639-1

iso639-1 Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

iso639-1

iso639-1 Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README