clay-resource-ref

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

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

Resource refs for clay entity

Installation
-----

``bash
$ npm install clay-resource-ref --save
`

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' }
}

`

Functions
---------

Available functions

| Signature | Description |
| ---- | ----------- |
| parse(ref) -> Object | Parse ref |
| refTo(resource, id) -> string` | Resolve ref to resource entity |

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