# clay-id

> Id generator for ClayDB

Latest version **3.1.1** (published 2019-06-18) · Apache-2.0 license · 0 weekly downloads

## Install

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

## 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 | 3.1.1 |
| Published | 2019-06-18 |
| First published | 2017-04-05 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 2 |
| Unpacked size | 279.7 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Taka Okunishi |
| Maintainers | okunishinishi, realglobe |
| Keywords | ClayDB |

## Links

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

## Dependencies (2)

- [uuid](https://npm.io/package/uuid.md) ^3.0.1
- [clay-constants](https://npm.io/package/clay-constants.md) ^3.5.1

## Recent versions

- 3.1.1 (latest) — 2019-06-18
- 3.0.4 — 2019-03-01
- 3.0.3 — 2019-02-24
- 3.0.2 — 2017-05-31
- 3.0.1 — 2017-04-05

## README

<img src="assets/images/clay-id-banner.png" alt="Title Banner"
                    height="148"
                    style="height:148px"
/>


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

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

[![Build Status][bd_travis_com_shield_url]][bd_travis_com_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-id
[bd_travis_url]: http://travis-ci.org/realglobe-Inc/clay-id
[bd_travis_shield_url]: http://img.shields.io/travis/realglobe-Inc/clay-id.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/realglobe-Inc/clay-id
[bd_travis_com_shield_url]: https://api.travis-ci.com/realglobe-Inc/clay-id.svg?token=aeFzCpBZebyaRijpCFmm
[bd_license_url]: https://github.com/realglobe-Inc/clay-id/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/realglobe-Inc/clay-id
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/realglobe-Inc/clay-id.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/realglobe-Inc/clay-id.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/realglobe-Inc/clay-id
[bd_gemnasium_shield_url]: https://gemnasium.com/realglobe-Inc/clay-id.svg
[bd_npm_url]: http://www.npmjs.org/package/clay-id
[bd_npm_shield_url]: http://img.shields.io/npm/v/clay-id.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>

Id generator 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-id --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 clayId = require('clay-id')

let id01 = clayId()

{
  let myEntity = {
    id: id01,
    foo: 'bar'
  }
  /* ... */
}

```


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

<!-- Section from "doc/guides/10.API Guide.md.hbs" Start -->

<a name="section-doc-guides-10-api-guide-md"></a>

API Guide
-----

+ [clay-id@3.1.1](./doc/api/api.md)
  + [create(args)](./doc/api/api.md#clay-id-function-create)
  + [newIdString()](./doc/api/api.md#clay-id-function-new-id-string)
  + [ClayId](./doc/api/api.md#clay-id-class)


<!-- Section from "doc/guides/10.API Guide.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-id/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-id · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._