Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/okunishinishi/node-evaljson

Node.js module to eval embed value in json.
https://github.com/okunishinishi/node-evaljson

Last synced: 2 months ago
JSON representation

Node.js module to eval embed value in json.

Awesome Lists containing this project

README

        

evaljson
==========

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/okunishinishi/node-evaljson
[bd_travis_url]: http://travis-ci.org/okunishinishi/node-evaljson
[bd_travis_shield_url]: http://img.shields.io/travis/okunishinishi/node-evaljson.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/okunishinishi/node-evaljson
[bd_travis_com_shield_url]: https://api.travis-ci.com/okunishinishi/node-evaljson.svg?token=
[bd_license_url]: https://github.com/okunishinishi/node-evaljson/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/okunishinishi/node-evaljson
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/okunishinishi/node-evaljson.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/okunishinishi/node-evaljson.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/okunishinishi/node-evaljson
[bd_gemnasium_shield_url]: https://gemnasium.com/okunishinishi/node-evaljson.svg
[bd_npm_url]: http://www.npmjs.org/package/evaljson
[bd_npm_shield_url]: http://img.shields.io/npm/v/evaljson.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

Eval embedded value in json. Useful to define message resource object.

Installation
-----

```bash
npm install evaljson --save
```

Usage
-----

```javascript
'use strict'

const evaljson = require('evaljson')

let locale = evaljson({
keys: {
NAME: 'My Awesome App'
},
titles: {
WELCOME_TITLE: 'Welcome to #{keys.NAME}!', // Embed value with "#{some_value}" syntax.
WHERE_WE_ARE: 'We are on $(hostname)' // Execute command with "$(command)" syntax

}
/* ... */
})

console.log(locale.titles.WELCOME_TITLE) // -> Welcome to My Awesome App!

````

API
---

| Signature | Description |
| --------- | ----------- |
| evaljson(src) | Eval src, with self values as context. |
| evaljson(src, context) | Eval with self values with context. |

License
-------
This software is released under the [MIT License](https://github.com/okunishinishi/node-evaljson/blob/master/LICENSE).