Skip to content package
resource v0.6.0 node.js resource library
node any 4 deps cjs open source
overview readme
license MIT
deps 4
unpacked Unknown
files Unknown
node any $ npm install resource@0.6.0n npmREADME GitHub-flavored package documentation.
downloads Across all versions.
Download trend unavailable.
compatibility Runtime metadata.
keywords Tagged topics.
resource model controller mschema contracts
install size Estimated unpacked size across 9 packages.
2.5 MB
Includes dependencies.
dependencies 4 direct · 1 outdated
versions Latest published Dec 30, 2016
maintainers Registry package owners.
contents resource
A resource can be considered a combination of a Model and a Controller. Resource methods can have associated schemas which act as a contract for the input and output of the method. Using resources provides unified invocation and validation of all function arguments and results.
Features
Provides EventEmitters for all resource methods
Provides hooks ( before, after ) for all resource methods
Methods' input and output arguments are validated with mschema
Built in datasource persistence using JugglingDB
Install with npm
marak
marak.squires@gmail.com
component install bigcompany/resource copy
API
resource.define(name, controller [optional ], mschema [optional ] ) Defines a new type of Resource.
name The name of the new resource to define. Example: weapon
controller An optional CommonJS module with exported methods. Any functions the CommonJS module exports are interpreted as controller methods.
mschema An optional mschema to the define the properties and methods of the resource using a schema.
Resource.method(name, fn, mschema [optional ]) Maps a new function to the resource.
name The name of the method as it should appear on the resource. Example: fire
fn The JavaScript function to bind to the method.
mschema An optional mschema to the define the input and output of the method.
Resource.property(name, mschema [optional ]) Maps a new property to the resource.
name The name of the property to add to the resource. Example: ammo
mschema An optional mschema to the define the input and output of the method.
Resource.persist(datasource) Enables persistence of Resource instances to a datasource.
Adds the following methods to the resource:
Resource.all
Resource.create
Resource.destroy
Resource.find
Resource.get
Resource.update
Resource.updateOrCreate
datasource The type of datasource to use. Can be string such as memory or an object literal such as { type: 'couchdb', username: 'foo', password: 'bar' }
Tests