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

couchdb-tools

v0.0.6

Published

A library of handy functions for use when working with CouchDB documents.

Downloads

19

Readme

couchdb-tools

npm install coucbdb-tools --save

A Node.js library of handy functions for use when working with CouchDB documents. All functions are database adapter agnostic.

Some functions are unique to this library, others are just wrappers around some of the best packages for the job from the Node.JS community - and in which case thanks for your hard work :)

ddoc(obj[,name])

Build a JSON/CouchDB compatible design document from a native JavaScript object. The main utility of this function is to translate any functions encountered in the design document into tidy JSON-safe strings. Design documents stored as valid JavaScript objects alongside your app source code rather than as raw JSON can benefit properly from version control and linting.

The name parameter is optional, and only required if you wish to create the design document's id too.

Example
var tools = require('couchdb-tools');

var projects = {
    views: {
        projectsById: {
            map: function (doc) {
                if ( doc.type == "project") {
                    emit(doc._id,doc);
                }
            }
        }
    }
}

var projectsDesignDoc = tools.ddoc(projects,'projects');

console.log(projectsDesignDoc);

The following will be output to the console:

{
    _id: '_design/projects',
    views: {
        projectsById: {
            map: 'function(doc){if(doc.type=="project"){emit(doc._id,doc)}}'
        }
    }
}

normalise(res)

Normalise a CouchDB result set into a flat array of document objects containing _id and _rev properties. The function will try to intelligently deal with the presence or lack of actual documents in the result as defined by the include_docs parameter.

Example

Given a raw CouchDB result set object similar to,

{
    total_rows: 10,
    offset: 0,
    rows: [
        {
            id: '...',
            key: '...',
            value: {...},
            doc: {...}
        },
        { ... },
        { ... },
        etc.
    ]
}

and invoking normalise on this object,

var tools = require('couchdb-tools');

res = tools.normalise(res);

console.log(res);

will produce the following output:

[
    {
        _id: '...',
        _rev: '...',
        propA: '...',
        propB: '...'
    },
    { ... },
    { ... },
    etc.
]

You can now inspect or manipulate this array of documents freely and save back to CouchDB in a bulk operation.

clone(obj)

Returns a deep clone of a document. Use it when you need to copy and manipulate a document without fear of corrupting the original data set.

find(collection,id)

Find a document by _id in an array.

setEach(collection,key,value)

Set a key to a certain value in every document in a collection.

equal(a,b)

Compares two documents for deep equality. Document _rev values are ignored and can differ while their parent documents are still considered equal.

extend(obj,obj[,obj,...])

Create a new document that is the result of copying the properties of an arbitrary number of documents into it. Documents at the right end of the parameter list are given precedent.

Example
var tools = require('couchdb-tools');
var a = {foo:'bar',baz:'qux'};
var b = {foo:'quux',qux:'quuux'};
var combination = tools.combine(a,b);
console.log(combination);

The following will be output to the console:

{
    foo: 'quux',
    baz: 'qux',
    qux: 'quuux'
}

shortid([seed])

Generate URI-safe, short, non-sequential unique ids. Optionally pass in a unique-for-your-app random number seed which will make your ids more secure. Passing the seed only needs to be done once at the start.

Example
var tools = require('couchdb-tools');
tools.shortid(343983);
console.log(tools.shortid());
console.log(tools.shortid());
console.log(tools.shortid());

Output similar to the following will be generated:

FG2Ws27qck
dGEEs27X15
oHeEydIXck

slug(text)

Converts a string into a URI-safe slug. Symbols are removed and foreign characters are coerced into their English equivalent.

Example
var tools = require('couchdb-tools');
console.log(tools.slug('Hello $$$ world'));

The following will be output to the console:

hello-world

sync(newColl,oldColl)

Algorithm for synchronising two collections of documents by _id. Useful for synchronising a local data set with the db (for example design documents or static app config data etc.).

The algorithm will compare the two sets of documents and determine which documents,

  • only exist in the old set
  • only exist in the new set
  • exist in both and are identical
  • exist in both and are different

It is left to your app code to determine how to handle each set. The results are exposed in the returned object, which has the following structure:

{
    onlyOld: [ ... ],
    onlyNew: [ ... ],
    bothAndEqual: [
        {
            old: {},
            new: {}
        },
        { ... }
    ],
    bothAndUnEqual: [
        {
            old: {},
            new: {}
        },
        { ... }
    ]
}