json-localizer

0.0.3 • Public • Published

localize-json

When you need humans to localize a json object from a config file. Typical use case is for a local config file to extend an application config on the fly.

Example

var Localizer = require('localize-json').Localizer;
var localizer = new Localizer(myobj);
localizer.where('path.to.prop').if({'prop': 'hasvalue'}.then({'addthis': 'propandvalue'}));
// `if` is optional
localizer.where('simpleprop').then('setthisvalue');

API

.where(rules)

rules: path to an object; eg.: prop, nested.prop.

Define which object(s) to target.

.if(rules)

rules: object of rules to filter the targeted objects. Eg.: `{'thisprop': 'hasthisvalue'}

Can be a single flat value instead of an object, and then the targeted key will be checked against this value.

.then(rules)

rules: object of rules to apply on the filtered objects. Eg.: {sethis: 'propandvalue', {anotherprop: 'tobeset'}}

Can be a single flat value instead of an object, and then the targeted key will be replaced by this value.

Can be a function, which then should return either a flat value or an object. The function will take the current targeted object as parameter.

See tests for more examples.

Readme

Keywords

Package Sidebar

Install

npm i json-localizer

Weekly Downloads

49

Version

0.0.3

License

WTFPL

Last publish

Collaborators

  • ybon