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 🙏

© 2025 – Pkg Stats / Ryan Hefner

couch_adapter

v1.1.1

Published

An adpater to the couchdb that gives CRUD API for a database

Downloads

3

Readme

Index

What is couch_adapter

couch_adapter is a simple abstraction that removes dependencies from couch specific logic and mechanisms from your API and/or website. It provides a simple CRUD interface that can be extended, modified, or replaced with another module at a later time, if couchDB needs replaced.

Installation

    npm install couch_adapter

Usage

Construction Usage

Creating a new adapter instance is as easy as:

    let adapter = require("couch_adapter")(options);

Constructor Options is an object that can contain the following:

  • db: The database you wish to attach to. (Required)
  • url: The couch url to connect to. -- Can be COUCH_URL environment Variable
  • user: Couch User details. -- Can be COUCH_USER environment Variable
  • pass: Couch Password details. -- Can be COUCH_PASS environment Variable
  • design: (Optional) Design document to use.
  • view: (Optional) view to be used
  • logLevel: Defaults to "info" ("fatal","error","warn","info","debug","trace")
  • read: Method for reading individual document if you want to override default.
  • readBulk: Method for reading many documents, if you want to override default.
  • create: Method for creating a document, if you want to override default.
  • deleteId: Method for deleting a document, if you want to override default.
  • update: Method for updating a document, if youw want to override default.

Creating an adapter returns an object with 7 methods: create, read, update, delete, readBulk, getVersion, and logLevel. All methods return a promise.

Create

Creates a document in the configured database.

    adapter.create(doc).then((result) => {
        console.log(result);
    });

Read

Retrieves a document that matches ID from database

    adapter.read(id).then((result) => {
        console.log(result);
    });

Read Bulk

Retrieves a set of documents from the database

    adapter.readBulk(skip, limit).then((result) => {
        console.log(result);
    });;

Update

Updates a document in the database. doc is document

    adapter.update(doc).then((result) => {
        console.log(result);
    });

Delete

Deletes a document in the database that matches the passed id.

    adapter.delete(id).then((result) => {
        console.log(result);
    });

getVersion

Retrieves the version of the module.

    adapter.getVersion().then((result) => {
        console.log(result);
    });

logLevel

Retrieves the logLevel of the object.

    adapter.logLevel().then((result) => {
        console.log(result);
    });

Results

Create/Update/Delete Result

{ 
  "ok": true,
  "id": "awest2",
  "rev": "1-f371adad4ce4b07c5702f103ae9f0864" 
}
Read Bulk Result
{ 
  "total_rows": 3,
  "offset": 0,
  "rows": 
   [ 
     { "id": "awest", "key": "EDL", "value": "awest" },
     { "id": "ckent", "key": "ID", "value": "ckent" },
     { "id": "jtest", "key": "PDL", "value": "jtest" } 
   ] 
}

Note: Read Bulk does not attach documents to the results.

Read Result

{ 
  "total_rows": 1,
  "offset": 0,
  "rows": 
   [ { "id": "awest", "key": "EDL", "value": "awest", "doc": { }} ] 
}

Version Result

{
    "version": "1.0.0"
}

logLevel Result

{
    "logLevel": "info"
}

Developers

Tests require a couch instance to execute. Configure settings in ./test/configData/config.json.

Scripts available:

  • npm test : Runs all tests in the /test/ directory

  • npm run coverage : generates an instanbul coverage report

  • npm run lint : Performs linting of the files with my style using jshint and jscs

Logs are generaged at either process.env.LOG_DIR or at the root directory of the calling application. Logs are generated using PINO, and follow the naming schema: couch_adapter_MMDDYYYY.log

If you have any questions, suggestions, or issues please contact me at [email protected].

Contributors Welcome!

Thanks