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

strongly-typed

v2.2.0

Published

Strongly typed javascript objects, self-validating, detailed error reports

Downloads

27

Readme

strongly-typed

Strongly-typed JavaScript objects, self-validating, with detailed error reports.

Support

IE9+ and everything else (same support as Object.create)

Usage

var TypeName = stronglyTyped(interface_definition, [prototype], [allowUnspecifiedFields])

interface_definition is a plain object of the expected structure with fields containing strings to match typeof in the typed objects. Additionally those strings can be prefixed with question mark ? to make them optional. If the field exist and is not null, it will be checked against the type.

You can also use null or empty {} to indicate that the field must exist, without specifying anything else about it.

You can also use [] to enforce field being an array (as typeof retrns "object" for arrays).

Example

var Person = stronglyTyped({
    "name": {
        first:"string",
        last:"string",
        middle:"?string"
    },
    "age": "number",
    "phoneNumber": "?string"
    "favorites": []
})

//create instance
var joe = Person({
    "name": {
        first:"Joe",
        last:"Average"
    },
    "age": 52,
    // "phoneNumber": null, or not defined at all
    "favorites": ["beer","game"]
})

//check type
Person.created(joe) === true

If [] is left empty in description, inner elements of the array are not validated. If there is first element in the array description, it's treated as schema for each element inside the array. Additional elements in description are omitted.

Example - array deep validation

var Person2 = stronglyTyped({
    "name": "string",
    "favorites": [
        {
            "id": "number",
            "value": "string"
        }
    ]
})

//create instance
var moe = Person2({
    "name": "Moe Average"
    "favorites": [
        { "id": 1, "value": "beer" },
        { "id": 2, "value": "game" }
    ]
})

//check type
Person2.created(moe) === true

More examples in tests/index.js

No new keyword

Strongly typed objects are factories, not classes. Because it's better that way. See: https://medium.com/javascript-scene/how-to-fix-the-es6-class-keyword-2d42bb3f4caf