# clay-resource-name

> Name object of ClayDB resources

Latest version **4.0.5** (published 2018-08-12) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install clay-resource-name
pnpm add clay-resource-name
yarn add clay-resource-name
bun add clay-resource-name
```

## 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 | 4.0.5 |
| Published | 2018-08-12 |
| First published | 2017-04-05 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 1 |
| Unpacked size | 41.2 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-resource-name
- Repository: https://github.com/realglobe-Inc/clay-resource-name
- Homepage: https://github.com/realglobe-Inc/clay-resource-name#readme
- Issues: https://github.com/realglobe-Inc/clay-resource-name/issues
- npm.io page: https://npm.io/package/clay-resource-name

## Dependencies (1)

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

## Recent versions

- 4.0.5 (latest) — 2018-08-12
- 4.0.4 — 2018-04-09
- 4.0.3 — 2017-08-27
- 4.0.2 — 2017-07-13
- 4.0.1 — 2017-04-05

## README

clay-resource-name
==========

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

Name object of ClayDB resources

<!-- 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-resource-name --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 clayResourceName = require('clay-resource-name')

{
  let name = clayResourceName('foo@example.com')
  /* ... */
}

```


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

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

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

API
---------

# clay-resource-name@4.0.4

Name object of ClayDB resources

+ Functions
  + [create(args)](#clay-resource-name-function-create)

## Functions

<a class='md-heading-link' name="clay-resource-name-function-create" ></a>

### create(args) -> `ClayResourceName`

Create a ClayResourceName instance

| Param | Type | Description |
| ----- | --- | -------- |
| args | * |  |








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