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

typsy

v1.0.0-beta.2

Published

Simple, chainable runtime type-checking for JavaScript

Downloads

5

Readme

typsy

Simple, chainable runtime type-checking for JavaScript

install

npm install --save typsy

import

// myfile.js
// ES module
import { typeCheck } from "typsy";

// Node.js
const typeCheck = require("typsy").typeCheck;

use

const x = "This is a string";

typeCheck(x).isString().yields(); // true

typeCheck(x).isInteger().yields(); // false

typeCheck(x).isString().or().isInteger().yields(); // true

the almighty yields

yields() returns whether the check is true or not. It must be called at the end to return true or false

checks

isTrue();
isFalse();
isInteger();
isString();
isEmptyString();
isAllWhiteSpace();
isBoolean();
isFloat();
isObject();
isNull();
isUndefined();
isArray();
isEmptyArray();
isFunction();
isDate();
isSet();
isWeakSet();
isMap();
isWeakMap();
isFloat();
isObject();
isEmptyObject();
isNaN();
isCollection();
isBigInt();
isSymbol();
isHTML();

methods

and();
or();
unless();

not modifier

pass any built-in check false

typeCheck(21).isArray(false).yields(); // returns true;

custom checks

Use the check function to insert a custom check function.

  function isNegative(value){
    return value < 0;
  }
  
  typeCheck(12).check(isNegative).yields(); // false
  typeCheck(-12).check(isNegative).yields(); // true
  

  typeCheck(12).isInteger().and().check(isNegative).yields(); // false
  typeCheck(-12).isInteger().and().check(isNegative).yields(); // true
  typeCheck(12).isInteger().or().check(isNegative).yields(); // true

yields callbacks

yields accepts a truth-handler and false-handler function respectively Both callbacks use the typeChecked value as its argument. This is especially useful for logging.

function myTrueCallback(){};

function myFalseCallback(){};

typeCheck(21).isInteger().yields(myTrueCallback, myFalseCallback); // returns true & myTrueCallback is fired
typeCheck("toot").isInteger().yields(myTrueCallback, myFalseCallback); // returns false & myFalseCallback is fired

with the yields callback you can even shorten your code:

// instead of 
if(typeCheck(21).isInteger().yields()){
  handleTrue(21);
} else {
  handleFalse(21)
}
// you can use this!
typeCheck(21).isInteger().yields(handleTrue, handleFalse);

neat recipes

myFunction(typeCheck(myVariable).isInteger().or().isString().yields()? myVariable : 1);