npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

resource

v0.8.1

Published

node.js resource library

Downloads

3,028

Readme

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

npm install resource

Install with component

component install bigcompany/resource

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

tap test