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

lazybones

v0.3.1

Published

An object-oriented abstraction of PouchDB using Backbone models and collections.

Downloads

6

Readme

Lazybones

A custom Backbone sync method for PouchDB, with support for views and changes. This is very similar to backbone-pouch but is slightly more dynamic and up-to-date for the latest PouchDB API.

Install

Download the latest version from our release page and use via a script tag. The variable Lazybones will be attached to window.

<script type="text/javascript" src="lazybones.js"></script>

If using Browserify or Node.js, you can install via NPM and use via require("lazybones").

$ npm install lazybones

Basic Usage

Method 1: PouchDB Plugin

If you want to generate a sync function with the Pouch database already attached, use the built in plugin interface. db.lazybones() will produce a sync function that uses db to fetch data.

PouchDB.plugin(Lazybones({
    // global options
}));

// later
var db = new PouchDB("mydb");
Backbone.Model.extend({
    sync: db.lazybones()
});

Method 2: Generic sync

The simplest method is to use the raw sync method directly. You will need to reference the Pouch database through the model.

var db = new PouchDB("mydb");
Backbone.Model.extend({
    sync: Lazybones.sync,
    pouchdb: db,
    syncOptions: {
        // options specific to this model
    }
});

Documentation

We have pretty HTML docs with inline source code hosted on Github Pages. This documentation is generated from block-level comments in the code using Doxxo, so you can also build them locally.

npm run build-docs

How to Build from Scratch

Lazybones uses Grunt to build a Browserify bundle from the original source found in lib/. When the command below completes, the compiled source will be saved to dist/ directory.

npm install && npm run build-js

Running the Unit Tests

Lazybones has several unit tests written for Node.js and the browser. Before running tests, install all test dependencies:

npm install

To get tests running on Node.js, run:

npm test

To run tests in the browser, start a test server with this command. When the server is running, navigate your browser to http://localhost:8000.

npm run dev