Serialize

Serializes an input value for dynamic code evaluation.

Installation

$ npm install eval-serialize

Usage

var serialize = require( 'eval-serialize' );

serialize( value )

Serializes an input value for dynamic code evaluation.

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

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(<timestamp>)'

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,

$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

License

MIT license.

Package detail

eval-serialize

readme