# clay-serial

> Conberter for ClayDB

Latest version **2.1.4** (published 2018-11-06) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install clay-serial
pnpm add clay-serial
yarn add clay-serial
bun add clay-serial
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.4 |
| Published | 2018-11-06 |
| First published | 2017-04-05 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 4 |
| Unpacked size | 54.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Taka Okunishi |
| Maintainers | realglobe |
| Keywords | ClayDB |

## Links

- npm: https://www.npmjs.com/package/clay-serial
- Repository: https://github.com/realglobe-Inc/clay-serial
- Homepage: https://github.com/realglobe-Inc/clay-serial#readme
- Issues: https://github.com/realglobe-Inc/clay-serial/issues
- npm.io page: https://npm.io/package/clay-serial

## Dependencies (4)

- [clay-id](https://npm.io/package/clay-id.md) ^3.0.1
- [clay-entity](https://npm.io/package/clay-entity.md) ^2.1.10
- [clay-constants](https://npm.io/package/clay-constants.md) ^3.0.2
- [clay-resource-ref](https://npm.io/package/clay-resource-ref.md) ^2.0.8

## Recent versions

- 2.1.4 (latest) — 2018-11-06
- 2.1.3 — 2018-11-05
- 2.1.2 — 2018-11-02
- 2.1.1 — 2018-04-14
- 2.0.3 — 2017-05-23
- 2.0.2 — 2017-04-07
- 2.0.1 — 2017-04-05

## README

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

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![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

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Conberter for ClayDB

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

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


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

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
}

```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Functions.md.hbs" Start -->

<a name="section-doc-guides-03-functions-md"></a>

Functions
---------

Available functions

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


<!-- Section from "doc/guides/03.Functions.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [Apache-2.0 License](https://github.com/realglobe-Inc/clay-serial/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

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

<!-- Links End -->

---
_Source: https://npm.io/package/clay-serial · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._