clay-resource-ref
v2.0.9
Published
Resource refs for clay entity
Downloads
105
Readme
clay-resource-ref
Resource refs for clay entity
Installation
$ npm install clay-resource-ref --save
Usage
'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.