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

odme

v2.0.5

Published

Not a real ODM but will ease dealing with any nosql storage

Downloads

112

Readme

odme

Build Status npm version Coverage Status

ODME is not an ODM library. It helps you create a class to keep model logic and has some default logic such as setter, getter, masking and creating id with prefixes. All these behaviours can be changed easily at defining your modle classes. It has an extension to support Couchbase and you can add your own extension to support other storages.

  • Full documation can be found here.
  • Source code is available at here.

How to use

You can create your model classes extending Base class of odme.

Base = require('odme').Base

class User extends Base
  
  props: {
    name:
      schema: Joi.string()
      whiteList: true
    age: 
      schema: Joi.number().min(0)
      whiteList: true
    total_logins: 
      schema: Joi.number().min(0)
      whiteList: false
  }

  user = new User { name: 'Arash', age: 32, city: 'Sydney', total_logins:10 }
  console.log user.key     #user_mJLGt-e6
  console.log user.doc     
    # { 
    #   name: 'Arash',
    #   age: 32,
    #   docType: 'user',
    #   docKey: 'user_mJLGt-e6' 
    # }
  console.log user.mask()
    # { 
    #   name: 'Arash',
    #   age: 32,
    #   docType: 'user',
    #   docKey: 'user_mJLGt-e6' 
    # }

  user.doc.city = 'Tehran'
  console.log user.doc
    # { 
    #   name: 'Arash',
    #   age: 32,
    #   city: 'Tehran',
    #   docType: 'user',
    #   docKey: 'user_mJLGt-e6' 
    # }
  console.log user.mask()
    # { 
    #   name: 'Arash',
    #   age: 32,
    #   docType: 'user',
    #   docKey: 'user_mJLGt-e6' 
    # }
  console.log user.mask('name,city')
    # { 
    #   name: 'Arash',
    #   city: 'Tehran'
    # }

You can extend Base class based on your adapters and set a library as source to store your doc property in key of your model object. Check odme and Couchbase integration here.

  Base = require('../build/main').CB
  
  db = new require('puffer') { host: 'localhost', name: 'test' }, true
  
  class Recipe extends Base
    source: db
    props: {
      name: 
        schema: Joi.string(),
        whiteList: true
      ingredients: 
        schema: Joi.array().items(Joi.string())
        whiteList: true
    }
  
  recipe = new Recipe { name: 'Pasta', ingredients: ['pasta', 'basil', 'olive oil'] }

  console.log recipe.key # recipe_yHr0blT
  recipe.save().then ->
    
    #after save you can get it like this
    Recipe.get(recipe.key).then (o) ->
      console.log o # return Recipe object

How to read this doc?

Base class is holding all the logic related to how to get a document and store it in the model class and how it will masked on outputs. Extensions such as CB are doing CRUD operations on models.

Need more?

  • Find the full list of available methods here.
  • This documentation is generated by groc, you can make a copy of in your local version.
  • You can run tests locally by npm test. Make sure you have development dependencies installed.