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

typescript-validator

v1.0.2

Published

Type-safe runtime validator for parsing unsafe data.

Downloads

327

Readme

Typescript Validator

A type-safe runtime validator for parsing unsafe data.

This library provides type-checked validator functions that help you take unsafe data (e.g. data from an API request) and validate it against your Typescript interfaces.

When used correctly, Typescript will throw and error if your validator function does not match the type that you are trying to validate.

Getting Started

Install from npm:

npm install --save typescript-validator

Given a type interface:

interface User {
	id: number,
	name?: string,
	email: string,
	workspaces: Array<string>
}

You can create a runtime validator function like this:

import * as validate from "typescript-validator"

const validator = validate.object<User>({
	id: validate.number(),
	name?: validate.optional(validate.string()),
	email: validate.string(),
	workspaces: validate.array(validate.string())
})

const valid = validator({id: 1, email: "hello", workspaces: []})
// true

The nice thing about this abstraction is that the type-checker will ensure that you've validated all fields of the type interface with the correct validator.

For example, here are some errors the type checker will help you with:

const validator = validate.object<User>({
	id: validate.number(),
	// name: validate.optional(validate.string()),  <-- "Property 'name' is missing in type"
	email: validate.string(),
	workspaces: validate.array(validate.string())
})

const validator = validate.object<User>({
	id: validate.number(),
	name: validate.optional(validate.string()),
	email: validate.number(), //  <-- Type 'string' is not assignable to type 'number'.
	workspaces: validate.array(validate.string())
})

You can easily create your own validators as well -- its just a function that returns a boolean. As you can see, we haven't verified that the email string is actually an email or the number of workspaces is not empty. We can easily write these functions ourselves.

const validator = validate.object<User>({
	id: validate.number(),
	name?: validate.optional(validate.string()),
	email: (email: string) => {
		return validate.string()(email) && /[^@]+@[^\.]+\.[a-zA-Z]+/.test(value),
	workspaces: (value: Array<string>) => {
		return validate.array((validate.string()))(value) && value.length > 0
	}
})

Happy hacking 🍉