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

function-guard

v1.0.0

Published

Guard functions by brand checks or duck typing

Downloads

3

Readme

function-guard

Function guard is a quick and dirty way to create runtime type checks against your functions.

If you're familiar with React's PropTypes, function-guard is basically that but for function arguments.

Usage

import {guard } from 'function-guard'

const add = guard('number', 'number', (a, b) => a + b)
add(1, 1) === 2

add('a', 'b') // TypeError: Argument 1 given to add is not a number (it's a string)

Guard has many included higher-order-functions which allow you to create different types of guards:

typeOf

Uses type-detect under the hood, to get the [Symbol.toStringTag] branding of a type:

import {guard, typeOf} from 'function-guard'
const addOne = guard(typeOf('number'), a => a += 1)

shapeOf

Traverses the properties of a given object and runs the guards on them

import {guard, typeOf, shapeOf} from 'function-guard'
const sumPoint = guard(shapeOf({ x: typeOf('number'), y: typeOf('number') }), ({ x, y }) => x + y)

arrayOf

Traverses the values of a given array and runs the guards on them

import {guard, typeOf, arrayOf} from 'function-guard'
const sumArray = guard(arrayOf(typeOf('number')), nums => nums.reduce((acc, cur) => acc + cur, 0))

oneOf

Expects the given value to be one of exactly these values (i.e. an enum check)

import {guard, oneOf} from 'function-guard'
const actions = {
  create: Symbol('create'),
  read: Symbol('read'),
  update: Symbol('update'),
  delete: Symbol('delete'),
}
const doAction = guard(oneOf(Object.values(actions)),  value => value[action]())

oneOfType

Detemines the value is one of any of the given guards

import {guard, typeOf, oneOfType} from 'function-guard'
const numberOrStringGuard = oneOfType(typeOf('string'), typeOf('number'))
const addNumberOrConcatStrings = guard(numberOrStringGuard, numberOrStringGuard, (a, b) => a + b)

instanceOf

Expects value to pass instanceof check

import {guard, instanceOf} from 'function-guard'
class Foo {}
const cloneFoo = guard(instanceOf(Foo), foo => Object.create(Foo.prototype, Object.getOwnPropertyDescriptors(foo)))

optional

Takes a guard and passes it if the given value is undefined

import {guard, typeOf, optional} from 'function-guard'

const guardedParseInt = guard(typeOf('string'), optional(typeOf('number')), parseInt)

any

A function that always passes

import {guard, typeOf, any} from 'function-guard'

const addToNumber = guard(typeOf('number'), any(), (num, whateverThisIs) => num + whateverThisIs)