# clay-resource-ref

> Resource refs for clay entity

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

## Install

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

## 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.0.9 |
| 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 | 3 |
| Unpacked size | 32.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Taka Okunishi |
| Maintainers | okunishinishi, realglobe |
| Keywords | ClayDB |

## Links

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

## Dependencies (3)

- [clay-id](https://npm.io/package/clay-id.md) ^3.1.1
- [clay-entity](https://npm.io/package/clay-entity.md) ^2.1.10
- [clay-resource-name](https://npm.io/package/clay-resource-name.md) ^4.0.5

## Recent versions

- 2.0.9 (latest) — 2019-06-18
- 2.0.8 — 2018-11-05
- 2.0.7 — 2018-11-02
- 2.0.6 — 2018-08-12
- 2.0.4 — 2018-04-14
- 2.0.3 — 2018-04-09
- 2.0.2 — 2017-06-11
- 2.0.1 — 2017-04-07
- 1.1.3 — 2017-04-05
- 1.0.3 — 2017-04-05

## README

clay-resource-ref
==========

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

Resource refs for clay entity

<!-- 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-ref --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 { parse, refTo } = require('clay-resource-ref')
const clayResource = require('clay-resource')
const clayEntity = require('clay-entity')

{
  let Org = clayResource('Org')
  let org01 = clayEntity({ id: 1, name: 'bar' })
  let user01 = clayEntity({ id: 1, username: 'foo' })

  let ref = refTo(Org, org01.id)
  console.log(ref) // -> Org#1
  user01.org = { $ref: ref }

  let parsed = parse(user01.org.$ref)
  console.log(parsed) // -> { resource: 'Org', id: '1' }
}

```


<!-- 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 |
| ---- | ----------- |
| `parse(ref) -> Object` | Parse ref |
| `refTo(resource, id) -> string` | Resolve ref to resource entity |


<!-- 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-resource-ref/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-ref · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._