Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kgryte/eval-serialize
Serializes an input value for dynamic code evaluation.
https://github.com/kgryte/eval-serialize
Last synced: 25 days ago
JSON representation
Serializes an input value for dynamic code evaluation.
- Host: GitHub
- URL: https://github.com/kgryte/eval-serialize
- Owner: kgryte
- License: mit
- Created: 2015-08-15T07:13:25.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2015-08-16T02:24:49.000Z (about 9 years ago)
- Last Synced: 2024-09-12T02:24:24.906Z (about 2 months ago)
- Language: JavaScript
- Size: 121 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Serialize
===
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][codecov-image]][codecov-url] [![Dependencies][dependencies-image]][dependencies-url]
> Serializes an input value for dynamic code evaluation.
## Installation
``` bash
$ npm install eval-serialize
```
## Usage
``` javascript
var serialize = require( 'eval-serialize' );
```
#### serialize( value )
Serializes an input value for dynamic code evaluation.
``` javascript
var str = serialize( 5 );
// returns '5'
str = serialize( 'beep' );
// returns '"beep"'
str = serialize( new Uint16Array( 4 ) );
// returns 'new Uint16Array([0,0,0,0])'
```
__Note__: the following input value types are __not__ currently supported...
* native `functions`
* `Map`
* `Set`
## Examples
``` javascript
var serialize = require( 'eval-serialize' );
console.log( serialize( 5 ) );
// returns '5'
console.log( serialize( 'beep' ) );
// returns '"beep"'
console.log( serialize( null ) );
// returns 'null'
console.log( serialize( undefined ) );
// returns 'undefined'
console.log( serialize( true ) );
// returns 'true'
console.log( serialize( false ) );
// returns 'false'
console.log( serialize( NaN ) );
// returns 'NaN'
console.log( serialize( Number.POSITIVE_INFINITY ) );
// returns 'Number.POSITIVE_INFINITY'
console.log( serialize( Number.NEGATIVE_INFINITY ) );
// returns 'Number.NEGATIVE_INFINITY'
console.log( serialize( [1,2,3] ) );
// returns '[1,2,3]'
console.log( serialize( {'beep':'boop'} ) );
// returns '{\"beep\":\"boop\"}'
console.log( serialize( new Buffer( 'beep' ) ) );
// returns 'new Buffer("YmVlcA==","base64")'
console.log( serialize( new Int32Array( [1,2,3,4] ) ) );
// returns 'new Int32Array([1,2,3,4])'
console.log( serialize( new Date() ) );
// returns 'new Date()'
console.log( serialize( function add( a, b ) {
return a + b;
}));
// returns 'function add( a, b ) {\n\treturn a + b;\n}'
```
To run the example code from the top-level application directory,
``` bash
$ node ./examples/index.js
```
## Tests
### Unit
Unit tests use the [Mocha](http://mochajs.org/) test framework with [Chai](http://chaijs.com) assertions. To run the tests, execute the following command in the top-level application directory:
``` bash
$ make test
```
All new feature development should have corresponding unit tests to validate correct functionality.
### Test Coverage
This repository uses [Istanbul](https://github.com/gotwarlost/istanbul) as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
``` bash
$ make test-cov
```
Istanbul creates a `./reports/coverage` directory. To access an HTML version of the report,
``` bash
$ make view-cov
```
---
## License
[MIT license](http://opensource.org/licenses/MIT).
## Copyright
Copyright © 2015. Athan Reines.
[npm-image]: http://img.shields.io/npm/v/eval-serialize.svg
[npm-url]: https://npmjs.org/package/eval-serialize
[travis-image]: http://img.shields.io/travis/kgryte/eval-serialize/master.svg
[travis-url]: https://travis-ci.org/kgryte/eval-serialize
[codecov-image]: https://img.shields.io/codecov/c/github/kgryte/eval-serialize/master.svg
[codecov-url]: https://codecov.io/github/kgryte/eval-serialize?branch=master
[dependencies-image]: http://img.shields.io/david/kgryte/eval-serialize.svg
[dependencies-url]: https://david-dm.org/kgryte/eval-serialize
[dev-dependencies-image]: http://img.shields.io/david/dev/kgryte/eval-serialize.svg
[dev-dependencies-url]: https://david-dm.org/dev/kgryte/eval-serialize
[github-issues-image]: http://img.shields.io/github/issues/kgryte/eval-serialize.svg
[github-issues-url]: https://github.com/kgryte/eval-serialize/issues