@intilfy/utils

Collection of i18n utilities

🌟 Features

✅️  Modern: ES Modules first and respect ECMAScript Internationalization API

✅️  Compatible: support CommonJS and various JS environments

✅️️  Minimal: Small and fully tree-shakable

✅️️  Type Strong: Written in TypeScript, with full JSdoc

💿 Installation

🐢 Node.js

# Using npm
npm install @intlify/utils

# Using yarn
yarn add @intlify/utils

# Using pnpm
pnpm add @intlify/utils

{
  "dependencies": {
    "@intlify/utils": "npm:@intlify/utils-edge@latest"
  }
}

🦕 Deno

You can install via import.

in your code:

/**
 * you can install via other CDN URL such as skypack,
 * or, you can also use import maps
 * https://docs.deno.com/runtime/manual/basics/import_maps
 */
import { ... } from 'https://esm.sh/@intlify/utils'

// something todo
// ...

import { ... } from 'https://esm.sh/@intlify/utils-edge'

// something todo
// ...

🥟 Bun

bun install @intlify/utils

🌍 Browser

in your HTML:

<script type="module">
/**
 * you can install via other CDN URL such as skypack,
 * or, you can also use import maps
 */
import { isLocale } from 'https://esm.sh/@intlify/utils'

// something todo
// ...
</script>

🍭 Playground

You can play the below examples:

• 🐢 Node.js: npm run play:node
• 🦕 Deno: npm run play:deno
• 🥟 Bun: npm run play:bun
• 🌍 Browser: npm run play:browser

🔨 Utilities

Common

• isLocale
• parseAcceptLanguage
• validateLanguageTag
• normalizeLanguageName

You can do import { ... } from '@intlify/utils' the above utilities

Navigator

• getNavigatorLanguages
• getNavigatorLanguage

You can do import { ... } from '@intlify/utils' the above utilities

⚠NOTE: for Node.js You need to do import { ... } from '@intlify/utils/node'

HTTP

• getAcceptLanguages
• getAcceptLanguage
• getAcceptLocales
• getAcceptLocale
• getCookieLocale
• setCookieLocale
• getPathLanguage
• getPathLocale
• getQueryLanguage
• getQueryLocale

The about utilies functions accpet Web APIs such as Request and Response that is supported by JS environments (such as Deno, Bun, and Browser)

Specialized environments

If you will use Node.js and H3, You can do import { ... } from '@intlify/utils/{ENV}' the above utilities.

The namespace {ENV} is one of the following:

• node: accpet IncomingMessage and Outgoing by Node.js http module
• h3: accept H3Event by HTTP framework h3

🙌 Contributing guidelines

If you are interested in contributing to @intlify/utils, I highly recommend checking out the contributing guidelines here. You'll find all the relevant information such as how to make a PR, how to setup development) etc., there.

©️ License

MIT