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

modela

v0.4.0

Published

Javascript model library

Downloads

20

Readme

Modela

Javascript model library to work with objects. To create model objects and check validations.

Features

  • Manual validation
  • Type check
  • Clean object

Install

$ npm install modela --save
# or
$ yarn add modela

And then, import it:

// ES2015+
import Modela from 'modela';

// CommonJS
var Modela = require('modela');

Usage

Create Model

const user = new Modela({
  username: {
    type: ['string'],
    validator: v => v.length >= 4,
    default: v => v + 'x'.repeat(4-v.length)
  },
  name: {
    type: ['string', 'undefined']
  },
  birthday: {
    type: ['date', 'undefined']
  },
  city: {
    type: ['string'],
    default: v => 'Tehran'
  },
  role: {
    type: ['string'],
    validator: v => ['agent', 'user', 'admin'].indexOf(v) > -1,
    default: v => 'user',
    importer: v => v.replace('role: ', '').trim(),
    formatter: v => `role: ${v}`,
    message: v => `role cannot be "${v}"! it should be one of agent, user or admin.`
  }
})

$set

To assign javascript object to Modela created schema, use $set method.

const userObject = {
  username: 'n',
  name: 'Amir Momenian',
  birthday: new Date('27 sept 1992'),
  role: 'role: zeus'
}
user.$set(userObject)

$check

To check validity of Modela object, use $check method.

const userCheck = user.$check()
// userCheck = {
//   result: false,
//   errors: {
//     username: 'Illegal value!',
//     role: 'role cannot be "zeus"! it should be one of "agent", "user" or "admin".'
//   }
// }
})

$clean

To clean Modela object (replace illegal values by default value), use $clean method.

const userClean = user.$clean()
// userClean = true
})

$export

To export Modela object to normal javascript object, use $export method.

const userExport = user.$export()
// userExport = {
//   username: 'nxxx',
//   name: 'Amir Momenian',
//   birthday: '1992-09-26T20:30:00.000Z',
//   city: 'Tehran',
//   role: 'role: user'
// }
})