npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@ambassify/language-object

v0.1.15

Published

Detection and conversion library for language objects.

Downloads

104

Readme

language-object

CircleCI

Installation

npm install --save @ambassify/language-object

Usage

This package expose a parse-js parser, a method to test for multilingual objects and a method to cast objects.

parser

For more info on parse-js see the documentation.

Example:

const parser = require('@ambassify/language-object/parser');

parse.register('languageObject', require())
parse().json().languageObject().parse({
    nl: 'hallo',
    en: 'hello'
});

Returns

{
    __type: 'multilingual',
    nl: 'hallo',
    en: 'hello'
}

isMultilingual

isMultilingual will check if the __type property equals multilingual if set.

  • If the __type property is set, but does not equal multilingual it will return false.
  • If the __type property is undefined this method will check whether the only enumerable properties are valid languages as supplied by the second argument to isMultilingual.
  • If __type is missing and languages is not set or empty it will always return false.
isMultilingual(languageObject, [languages])

Example:

const isMultilingual = require('@ambassify/language-object/ismultilingual');

const obj = {
    nl: 'hallo',
    en: 'hello'
};

isMultilingual(obj, ['en','nl']); // true
isMultilingual(obj, ['en']); // false

cast

Casts language-object to include __type and valid language keys.

Unless force is set to true, it uses isMultilingual to validate objects first, if an object is not valid it will return null.

cast(languageObject, [languages], [force=false])

Example:

const cast = require('@ambassify/language-object/cast');

const obj = {
    nl: 'hallo',
    en: 'hello'
};

cast(obj, ['en','nl']);

Returns

{
    __type: 'multilingual',
    nl: 'hallo',
    en: 'hello'
}

translate

Takes in an object an selects only the language key that you would like to have selected.

cast(sourceObject, [selectLanguage], [availableLanguages])

Example:

const cast = require('@ambassify/language-object/translate');

const obj = {
    hi_nl: 'hallo',
    hi_en: 'hello',
    nested: {
        regular: 'key',
        value_nl: 'in dutch',
        value_en: 'in english'
    }
};

translate(obj, 'en', ['en','nl']);

Returns

{
    hi: 'hello',
    nested: {
        regular: 'key',
        value: 'in english'
    }
}