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

lib-marshal

v0.8.0

Published

marshalled object validation

Downloads

112

Readme

lib-marshal

marshalled object validation

Build Status

Install

npm install --save lib-marshal

Usage

define your types

var marshal = require('lib-marshal');

// define some types
var stringProto  = new marshal.StringType;
var messageProto = new marshal.StructType;

messageProto.add('from'   , stringProto);
messageProto.add('dest'   , stringProto);
messageProto.add('body'   , stringProto);
messageProto.add('subject', stringProto);

prepare data for the client

Prepare data for the client, by stripping out unused properties and validating data types.

// create a data object
var m = {
  from: 'bob',
  dest: 'kim',
  body: 'hello world'
};

// ready it for the world, or die trying
JSON.stringify(messageProto.marshal(m))

parse incoming data

Validate an incoming object, or throw an error.

var message = messageProto.marshal(JSON.parse(str))

options

numbers

var num = new NumberType({max: 10, min: 0})

num.marshal(-1)
// Error: Value <-1> must be greater than 0 at <var>

num.marshal(20)
// Error: Value <20> must be less than 10 at <var>

strings

var str = new StringType({min: 1, max: 20, match: /.@.\../})

str.marshal('bob AT aol.com')
// Error: Value <bob AT aol.com> must be match the pattern </.@.\../> at <var>

untyped (json)

If you're not ready for a schema yet, you can allow arbitrary data with the JsonType type

var type = new JsonType()
var json = type.marshal({one: 1, two: 'two'})

errors

Handy dandy error messages

var message = new StructType;
var address = new StructType;
var content = new StructType;

content.add('subject', new StringType)
content.add('body', new StringType)
content.add('author', address)

address.add('name', new StringType)
address.add('email', new StringType)

message.add('from', address)
message.add('to', address)
message.add('content', content)

message.marshal({
  to: {
    name    : "Kim",
    email   : "[email protected]"
  },
  from      : {
    name    : "Bob",
    email   : "[email protected]"
  },
  content   : {
    body    : "This is a test",
    subject : "Hello World",
    author  : "Bob"
  }
});

You'll receive a helpful error when things fail to parse

Error: Expected <object> but Received "Bob" of type <string> at <var>.content.author

see also

  • lib-schema generate a marshaller from a json schema