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

object-model

v1.0.4

Published

Using any object as a model

Downloads

20

Readme

ObjectModel

ObjectModel is a tiny package that help you use any object as a Model.

How to install

Add ObjectModel to your project with the following command:

npm install object-model

Include it when you needed:

var OM = require('object-model');

How to use

Let's say, we want to define carModel, as a model to define cars:

var carModel = {
    make: '',
    year: '',
    name: '',
    mpg: ''
};

Create the model from carModel object with:

OM.createModel(carModel);

From now on, you can create any data object with carModel model:

var rav4 = carModel.init('toyota', 2000, 'RAV4', 27);
console.log(rav4);

or if you want to write more meaningful code:

var crv = carModel.init({
    make: 'honda',
    year: 2005,
    name: 'CRV'
});
console.log(crv);

You can skip some key, it will automatically takes the default value from model.

Real-life usage

For example, we use ObjectModel with MongoDB in a simple To Do app.

Firstly, we define our task model:

var taskModel = {
    task: '',
    timeCreated: 0,
    done: false
}

Then we create a model from task object with ObjectManager:

OM.createModel(taskModel);

Now the taskModel is available to use. Let's insert a new task to MongoDB:

db.collection('tasks').insertOne(
    taskModel.init('Pay gas bill', Date.now()),
    function(err, result) {
        if (err) console.error(err);
        else console.log(result);
    }
);

Or insert many document at a time:

db.collection('tasks').insertMany(
    [
        taskModel.init('Pay gas bill', Date.now()),
        taskModel.init('Pay phone bill', Date.now()),
        taskModel.init('Pay car loan', Date.now()),
    ],
    function(err, result) {
        if (err) console.error(err);
        else console.log(result);
    }
);

Contribute

The project is available on Github here: https://github.com/huytd/object-model

I know my code isn't cool yet, there are many potential issues with such a logic. Please help me improve it if you can. Feel free to create Pull Request or do code review for other PR.

License

This project published under MIT License, please refer LICENSE.md for more detail.