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

has-shape

v2.0.1

Published

Super simple runtime type-checking for Javascript objects

Downloads

3

Readme

hasShape() on NPM typings: included dependencies: 0

Super simple runtime type-checking for Javascript objects.

Also provides relevant typing for Typescript and type-aware IDEs (e.g. VS Code).

Installation

npm install has-shape

Basic usage

hasShape() receives a value, and a shape specifier. It then determines whether the value matches the shape.

import hasShape from 'has-shape';

// ...

if (hasShape(formData, { name: 'string', password: isValidPassword })) {
    // ...
}

In this example, formData must pass the following conditions:

  • It is an object.
  • It has a name property, which is a string.
  • It has a password property, which passes the isValidPassword predicate.

Supported shapes

  • Object shapes, e.g. { name: 'string', age: 'number' }
  • typeof strings
    • 'number', 'string', etc.
    • Also includes 'any' and 'unknown'. These match any type, and the typings map to the matching TS type.
  • Nested object shapes
  • Regular Expressions
  • Predicate functions
  • Assertion functions
  • Array shapes (via arrayShape())

Additional functions

arrayShape()

Creates a shape which matches arrays containing elements of the given specifier.

if (hasShape(value, arrayShape('number'))) { // True if value is an array of numbers

By default, empty arrays are allowed. This can be overridden by passing an options object with disallowEmpty: true.

const teamShape = {
    name: 'string',
    members: arrayShape({
        name: 'string',
        age: 'number'
    }, { disallowEmpty: true })
};

if (hasShape(obj, teamShape)) {

assertShape()

The same as hasShape(), but rather than returning a boolean, instead throws a descriptive error if the value does not match the shape.

assertShape(person, personShape); // Throws if person does not match personShape

shape()

Creates an assertion function for the given shape.

const personShape = shape({ name: 'string', age: 'number' });

personShape(person); // Throws if person does not match personShape