GithubHelp home page GithubHelp logo

ssevertson / resourceful Goto Github PK

View Code? Open in Web Editor NEW

This project forked from flatiron/resourceful

0.0 3.0 0.0 528 KB

an isomorphic Resource engine for JavaScript

Home Page: http://github.com/flatiron/resourceful

License: Apache License 2.0

JavaScript 100.00%

resourceful's Introduction

Synopsis

  • Isomorphic Resource engine for JavaScript
  • Resources are business logic wrapped in prototypical models with schema and validation
  • Resources support several data-providers
    • Memory
    • File-System
    • CouchDB
    • MongoDB
    • REST
    • socket.io

Status

Build Status

Features

Installation

$ [sudo] npm install resourceful

Usage

Simple case

var resourceful = require('resourceful');

var Creature = resourceful.define('creature', function () {
  //
  // Specify a storage engine
  //
  this.use('couchdb');
  
  //
  // Specify some properties with validation
  //
  this.string('diet');
  this.bool('vertebrate');
  this.array('belly');

  //
  // Specify timestamp properties
  //
  this.timestamps();
});

//
// Now that the `Creature` prototype is defined
// we can add custom logic to be available on all instances
//
Creature.prototype.feed = function (food) {
  this.belly.push(food);
};

Engines

Documentation

See the wiki for more documention.

API

Resource Constructor Methods

These methods are available on all user-defined resource constructors, as well as on the default resourceful.Resource constructor.

  • Resource.get(id, [callback]): Fetch a resource by id.
  • Resource.update(id, properties, [callback]): Update a resource with properties.
  • Resource.destroy(id, [callback]): Destroy a resource by id.
  • Resource.all([callback]): Fetches all resources of this type.
  • Resource.find(properties, [callback]): Find all resources of this type which satisfy obj conditions.
  • Resource.save(inst, [callback]): Saves the specified resource instance inst by overwriting all properties.
  • Resource.create(properties, [callback]): Creates a new instance of the Resource with the specified properties.
  • Resource.new(properties): Instantiates a new instance of the Resource with the properties.

Resource Instance Methods

  • Resource.prototype.save([callback])
  • Resource.prototype.update(properties, [callback])
  • Resource.prototype.destroy([callback])
  • Resource.prototype.reload([callback])

Relationship Constructor Methods

These methods are available on all user-defined resource constructors which are in a relationship

  • Parent.children(id, [callback]): Fetches all the children for the specified id.
  • Parent.createChild(id, properties, [callback]): Create a child for id with the specified properties.
  • Child.byParent(id, [callback]): Fetches all the children for the parent given by id.

Relationship Instance Methods

  • Parent.prototype.children([callback])
  • Parent.prototype.createChild(properties, [callback])
  • Child.prototype.parent([callback]): Fetches the parent of the given child instance.

Relational Resources

Resourceful supports a simple Resource.parent API, supports one-one, one-many, and many-many relationships.

Documentation

Tests

All tests are written with vows and should be run with npm:

  $ npm test

License

Copyright 2012 Nodejitsu, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

resourceful's People

Contributors

bmeck avatar chbm avatar chjj avatar coderarity avatar colinf avatar coreyjewett avatar ericchaves avatar fb55 avatar fent avatar gradus avatar indexzero avatar indutny avatar jfhbrook avatar jkroso avatar marak avatar mmalecki avatar nrw avatar pksunkara avatar richmarr avatar slaskis avatar ssevertson avatar tswast avatar xjamundx avatar yawnt avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.