y18n
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/y18n package

    5.0.8 • Public • Published

    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

    Install

    npm i y18n

    DownloadsWeekly Downloads

    38,970,559

    Version

    5.0.8

    License

    ISC

    Unpacked Size

    23.4 kB

    Total Files

    9

    Last publish

    Collaborators

    • bcoe
    • nexdrew
    • oss-bot