clay-serial

clay-serial
==========

[![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/realglobe-Inc/clay-serial
[bd_travis_url]: http://travis-ci.org/realglobe-Inc/clay-serial
[bd_travis_shield_url]: http://img.shields.io/travis/realglobe-Inc/clay-serial.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/realglobe-Inc/clay-serial
[bd_travis_com_shield_url]: https://api.travis-ci.com/realglobe-Inc/clay-serial.svg?token=
[bd_license_url]: https://github.com/realglobe-Inc/clay-serial/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/realglobe-Inc/clay-serial
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/realglobe-Inc/clay-serial.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/realglobe-Inc/clay-serial.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/realglobe-Inc/clay-serial
[bd_gemnasium_shield_url]: https://gemnasium.com/realglobe-Inc/clay-serial.svg
[bd_npm_url]: http://www.npmjs.org/package/clay-serial
[bd_npm_shield_url]: http://img.shields.io/npm/v/clay-serial.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

Conberter for ClayDB

Installation
-----

``bash
$ npm install clay-serial --save
`

Usage
---------

`javascript
'use strict'

const { serialize, deserialize } = require('clay-serial')

{
let book = {
title: 'Wonderful Banana',
version: 15,
publishedAt: new Date('2012/12/12')
}

let serialized = serialize.all(book)

console.log(serialized) // Serialized value

let deserialized = deserialize.all(serialized)
console.log(deserialized) // Restore the original data
}

`

Functions
---------

Available functions

| Signature | Description |
| ---- | ----------- |
| deserialize(Serialized) -> Object | Deserialize value |
| deserialize.all(values) -> Object. | Deserialize object properties |
| deserialize.recursive(values) -> Object. | Deserialize recursively |
| serialize(value) -> Serialized | Serialize value |
| serialize.all(values) -> Object. | Serialize object properties |
| serialize.recursive(values) -> Object. | Serialize recursively |
| typeOf(value) -> string | Get type of an value |
| withType(value, type) -> *` | Convert value with type |

License
-------
This software is released under the Apache-2.0 License.

Links
------

+ [ClayDB][clay_d_b_url]
+ [Realglobe, Inc.][realglobe,_inc__url]

[clay_d_b_url]: https://github.com/realglobe-Inc/claydb
[realglobe,_inc__url]: http://realglobe.jp