pick-by-lang v1.0.0

pick-by-lang

Helper for transforming objects with i18n content

Installation

yarn add pick-by-lang

Or if you prefer npm:

npm i pick-by-lang

Usage

TL;DR

import { pickByLang } from 'pick-by-lang'
 
const pickRu = pickByLang('ru')
const pickEn = pickByLang('en')
 
const content = {
  title: {
    en: 'Shop',
    ru: 'Магазин',
  }
})
 
console.log(pickRu(content)) // { title: 'Магазин' }
console.log(pickEn(content)) // { title: 'Shop' }

Docs

pickByLang accepts two parameters — lang and content for translating. If content is not supplied, it returns function with one argument.

Example:

const content = {
  title: {
    en: 'Shop',
    ru: 'Магазин',
  }
})
 
// Simple usage
console.log(pickByLang('ru', content)) // { title: 'Магазин' }
 
// Curried usage
const pickRu = pickByLang('ru')
console.log(pickRu(content)) // { title: 'Магазин' }

Lib can handle objects constructed by following rules:

1. Any field can contain language variants. If field does not contain language variants, it will be left untouched.

Example:

const content = {
  title: {
    en: 'Shop',
    ru: 'Магазин',
  },
  site: 'https://google.com'
}
 
console.log(pickByLang('en', content)) // { title: 'Shop', site: 'https://google.com' }

2. You can create fields for specific languages and hide it for other.

Example:

const content = {
  name: {
    en: 'Igor',
    ru: 'Игорь',
  },
  slides: [
    {
      name: 'Hop-hey, only for ru',
      onlyFor: ['ru'],
    },
    {
      name: 'Text for any language',
    },
  ],
}
 
console.log(pickByLang('en', content)) // { name: 'Igor', slides: [{ name: 'Text for any language' }] }
console.log(pickByLang('ru', content)) // { name: 'Igor', slides: [{ name: 'Hop-hey, only for ru' }, { name: ''Text for any language' }] }

That's all. Enjoy!