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

hyperbone-model-with-io

v0.1.21

Published

HTTP interactions for Hyperbone Models

Downloads

2

Readme

Hyperbone Model (With IO)

This module is no longer being maintained

It is replaced by HalogenJS Resource.

Build Status

tldr;

Adds HTTP interactions to Hyperbone Models. Ridiculously early push this.

Intro

Adds a 'fetch' method for loading a Hypermedia resource from a server, and a 'execute' method for sending Command data to a server.

Installation

Install with npm(1):

$ npm install --save hyperbone-model-with-io

Tests

If you don't already have grunt..

$ npm install -g grunt-cli

After cloning the repo..

$ npm install

To run the tests

$ npm test

Usage

Instead of ...

var Model = require('hyperbone-model').Model;

do...

var Model = require('hyperbone-model-with-io').Model;

API

.fetch()

Assuming your model has a self href, it will load the hypermedia and fire a sync event, as per normal Backbone. Parameters in the callback are the model and the request response.

.execute( "command name" )

If you're using the '_commands' functionality, calling .execute will seralise the command's properties and PUT/POST/DELETE etc to the specified HREF.

HTTP error codes 201, 200 and 202 are considered successful. ANything else counts as an error. On success, a .fetch() automatically happens. If it's an error this doesn't happen.

It will also trigger executed or execution-failed which is passed the command that failed. This should bubble up to the parent model.

.execute( "command name", callback )

If you pass a callback, instead of an automatic .fetch() happening your callback is called so you can manually decide whether or not to resync.

The parameters passed to the callback are err and response. 201, 200 and 202 are considered successful. ANything else counts as an error.

It will also trigger executed or execution-failed, which is passed the command that failed.

And this gives you Hyperbone Models with the HTTP extensions. This module is badly named really. This should bubble up to the parent model.

License

MIT