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

typist.js

v0.1.1

Published

Type checking in JS

Downloads

1

Readme

Typist

Build Status Coverage Status

Type check function return values at run time, or type check any value any time.

  1. Install
  2. All In One Example
  3. Return Values
  4. Any Value

Install

npm install typist.js --save

All in one example

Seamlessly type check the return type as well as input types for the life of the function.

var makeArray = type.takes(Array, String, Number)
                    .does(function(input, foo, bar) {
                      input.push(foo, bar);
                      return input;
                    })
                    .returns(Array)
                    .done();

makeArray([], "1", 2); // ["1", 2]
makeArray([], 1, 2); // Throws TypistError

Or you can use the features separately but all together for the same effect.

var type = require("typist");

var makeArray = type(Array, function(input, foo, bar) {
  type.checks([Array, input], [String, foo], [Number, bar]);
  input.push(foo, bar);
  return input;
});

makeArray([], 1, 2); // throws TypistError
makeArray([], "1", 2); // ["1", 2]

Return Values

Typist creates a curried function of your type and will check against that type any time a value is returned from it. Ensure your function will always return what you expect it to.

var type = require("typist");

var makeArray = type(Array, function(input) {
  return input.push("Foo");
});

makeArray("string"); // throws TypistError
makeArray([]); // ["Foo"]

Any Value

Type check any value any time

var type = require("typist");

type.is.array(["Foo"]); // true
type.is.string(["Bar"]); // false

type.array(["Foo"]); // ["Foo"]
type.array("Bar"); // throws TypistError

You can also type check many values, which is useful for checking all your function arguments at the top of the function.

var type = require("typist");

var makeArray = function(input, foo, bar) {
  type.checks([Array, input], [String, foo], [Number, bar]);
  input.push(foo, bar);
  return input;
});

makeArray([], 1, 2); // throws TypistError
makeArray([], "1", 2); // ["1", 2]

Currently Supporting

I'm adding more types as I have time, but currently have:

  • Object
  • Array
  • String
  • Number
  • Function
  • Boolean
  • Date
  • RegEpx
  • Error

Testing

You will need to install grunt-cli if you haven't already. Run grunt test to run tests and coverage. Coverage is saved in coverage folder.