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

lounge

v0.27.0

Published

Simple Mongoose-inspired ODM for Couchbase

Downloads

140

Readme

Lounge

Simple Mongoose-inspired ODM for Couchbase.

npm version build status stabdardjs License

Installation

npm install lounge

Overview

Lounge is a simple, somewhat opinionated, Mongoose-inspired ODM for Couchbase. Main goal is to provide modeling tool framework for working with Couchbase databases in an asynchronous environment of Node.js.

var lounge = require('lounge')
lounge.connect({
  connectionString: 'couchbase://127.0.0.1',
  bucket: 'lounge_test'
})

var schema = lounge.schema({ name: String })
var Cat = lounge.model('Cat', schema)

var kitty = new Cat({ name: 'Zildjian' })
kitty.save(function (err) {
  if (err) // ...
  console.log('meow')
})

Features:

  • Schema definition
  • Strict modeling based on schema
  • Schema extension
  • Automatic type validation and custom validation
  • Document upsert and removal
  • Embedded (referenced) documents
  • Automatic and manual population of embedded (referenced) document
  • Middleware including pre and post hooks
  • Indexing using reference lookup documents
  • Promise support

Outside of the scope of this module:

  • Document and view management. There are too many patterns and ways of performing document and view management and view lookup that it is impractical to accommodate anything sane within a simple ODM. This can easily be expanded on top of Lounge.
  • View queries. For same reasons this falls outside of the scope of Lounge.
  • N1QL index management and N1QL queries. For the same reasons this falls outside of the scope of this library.
  • Full Text Search index management and FTL queries. For the same reasons this falls outside of the scope of this library.
  • Automatic document removal on key change. That is if a document key property changes, the new document is saved under the new key. The old document sticks around under the old key. There are too many implications if we start automatically handling document removal in this scenario. This should be handled by the user of this module. In most use cases this should not really be an issue.

Documentation

Tests

Module automated tests can be run using npm test command. The tests are executed using Couchbase mocking. To run tests against an actual local database create a bucket lounge_test and remove LOUNGE_COUCHBASE_MOCK=true from test script property in package.json.

Credits

Lots of code and design inspired by Mongoose. Icon made by Cursor Creative from www.flaticon.com is licensed by CC 3.0 BY

License

Copyright 2015 - 2017 Bojan D.

Licensed under the MIT License.