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

ampersand-collection-rest-mixin

v6.0.0

Published

A mixin for extending ampersand-collection with restful methods.

Downloads

8,652

Readme

ampersand-collection-rest-mixin

Part of the Ampersand.js toolkit for building clientside applications.

A mixin for extending ampersand-collection with restful methods. To make it behave much like Backbone.

install

npm install ampersand-collection-rest-mixin

api

create(model, options)

Create a new instance of a model in this collection. Add the model to the collection immediately.

options
  • wait - default: false. If set to true, we wait for the server to agree before updating the collection.
fetch(options)

Fetch the default set of models for this collection, and set them onto this collection.

options
  • reset [boolean] - default: false. Executes the reset method on the collection with server response instead of the set method.
  • set [boolean] - defaut: true. When left true, executes the reset method on the collection with server response. When set to false, the collection will not be modified after the HTTP request is complete. This enables use of of the collection strictly as an API client. The success and error handlers are still triggered. Useful in rare circumstances.
  • success(collection, response, options) [function] - default: undefined. Called after the XHR has completed successfully and the collection is updated.
  • error(model, response, options) [function] - default: undefined. Called after the XHR has failed.
  • always(err, response, body) [function] - default: undefined. Called when request finishes no matter what the result.
fetchById(id, options, cb)

fetches a model and adds it to collection when fetched

getOrFetch(id, options, cb)

get or fetch a model by id

options

same options as fetch(), with the addition of:

  • all [boolean] - default: false. If true, this fetches the entire collection and then returns the requested model.
sync()

proxy to ampersand-sync

example

var Collection = require('ampersand-collection');
var restMixin = require('ampersand-collection-rest-mixin');


module.exports = Collection.extend(restMixin, {
    sampleMethod: function () {
        // now we've got restful methods in our collection
        this.sync( ... );
        this.fetch( ... );
        this.create( ... )
    }
});

credits

All credit for this approach in backbone goes to Jeremy Ashkenas and the rest of the Backbone and Underscore authors.

license

MIT