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

@devs-toolbox/typeguard

v1.0.1

Published

Simple typeguard definitions

Downloads

5

Readme

Dev's Toolbox // Typeguard

Utilities for checking the types of values at runtime, helpful for working with external or async loaded data within TypeScript.

API

createObjectTypeguard(shape)

Create a suite of typeguard functions for the given object shape.

  • shape - The shape of the object to create a typeguard for.

Returns: DecoratedTypeguard

Shape

A TypeGuard Shape is an object whose keys specify how to analyze an objects types.

const guards = createObjectTypeguard({
  id: "number", // Strings imply "typeof" checks
  name: "string",
  active: "boolean",
  notes: {array: "string"}, // An array of strings
  metadata: {record: ["string", "number", "boolean"]} // A record whose values are strings, numbers or booleans
  website: {optional: "string"} // Optional value
  version: {literal: 1} // Literal value
});

DecoratedTypeguard

The return value of createObjectTypeguard is a function which can take an object and check if it matches the provided shape. This function also contains three additional guards as properties:

const isThing = createObjectTypeguard(THING_SHAPE);

isThing(value); // Check if `value` satisfies Thing
isThing.strict(value); // Check if `value` is exactly a Thing with no additional properties
isThing.array(value); // Check if `value` is an array of Things
isThing.strictArray(value); // Check if `value` is an array of strictly-checked Things

checkValue(value, checker)

Check a single non-object type.

  • value - The value to check the type of
  • checker - The type expression to check against

Returns: boolean

checkArray(value checker)

Check the type validity of the elements in an array.

  • value - The value to check the type of
  • checker - The type expression to check against

Returns: boolean

checkObject(value, shape)

Quickly check a single object shape.

  • value - The value to test the type validity of
  • shape - The shape the object should be, as a typeguard shape

Returns: boolean