Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inDemoInstall

y18n

Package Overview
Dependencies
0
Maintainers
3
Versions
22
Issues
File Explorer

Advanced tools

y18n

the bare-bones internationalization library used by yargs

    5.0.8latest
    Github

Version published
Maintainers
3
Weekly downloads
58,551,861
increased by8.44%

Weekly downloads

Changelog

Source

5.0.8 (2021-04-07)

Bug Fixes

  • deno: force modern release for Deno (b1c215a)

Readme

Source

y18n

NPM version js-standard-style Conventional Commits

The bare-bones internationalization library used by yargs.

Inspired by i18n.

Examples

simple string translation:

const __ = require('y18n')().__; console.log(__('my awesome string %s', 'foo'));

output:

my awesome string foo

using tagged template literals

const __ = require('y18n')().__; const str = 'foo'; console.log(__`my awesome string ${str}`);

output:

my awesome string foo

pluralization support:

const __n = require('y18n')().__n; console.log(__n('one fish %s', '%d fishes %s', 2, 'foo'));

output:

2 fishes foo

Deno Example

As of v5 y18n supports Deno:

import y18n from "https://deno.land/x/y18n/deno.ts"; const __ = y18n({ locale: 'pirate', directory: './test/locales' }).__ console.info(__`Hi, ${'Ben'} ${'Coe'}!`)

You will need to run with --allow-read to load alternative locales.

JSON Language Files

The JSON language files should be stored in a ./locales folder. File names correspond to locales, e.g., en.json, pirate.json.

When strings are observed for the first time they will be added to the JSON file corresponding to the current locale.

Methods

require('y18n')(config)

Create an instance of y18n with the config provided, options include:

  • directory: the locale directory, default ./locales.
  • updateFiles: should newly observed strings be updated in file, default true.
  • locale: what locale should be used.
  • fallbackToLanguage: should fallback to a language-only file (e.g. en.json) be allowed if a file matching the locale does not exist (e.g. en_US.json), default true.

y18n.__(str, arg, arg, arg)

Print a localized string, %s will be replaced with args.

This function can also be used as a tag for a template literal. You can use it like this: __`hello ${'world'}`. This will be equivalent to __('hello %s', 'world').

y18n.__n(singularString, pluralString, count, arg, arg, arg)

Print a localized string with appropriate pluralization. If %d is provided in the string, the count will replace this placeholder.

y18n.setLocale(str)

Set the current locale being used.

y18n.getLocale()

What locale is currently being used?

y18n.updateLocale(obj)

Update the current locale with the key value pairs in obj.

Supported Node.js Versions

Libraries in this ecosystem make a best effort to track Node.js' release schedule. Here's a post on why we think this is important.

License

ISC

Keywords

FAQs

What is y18n?

the bare-bones internationalization library used by yargs

Is y18n popular?

The npm package y18n receives a total of 55,909,146 weekly downloads. As such, y18n popularity was classified as popular.

Is y18n well maintained?

We found that y18n demonstrated a not healthy version release cadence and project activity because the last version was released a year ago.It has 3 open source maintainers collaborating on the project.

Last updated on 07 Apr 2021

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket[email protected]

Product

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc