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

proptest

v0.0.4

Published

Property based testing for TypeScript

Downloads

1,005

Readme

Property-based testing for TypeScript and JavaScript

This is an implementation of property-based testing a'la QuickCheck for TypeScript. It works with plain JavaScript and languages like CoffeeScript too.

Shrinking is done by generating lazy rose trees of values directly. This means that you can map and chain generators and get correct shrinking functions "for free". This is a deviation from the original Haskell library but works well in languages without typeclasses. (The same approach is taken in other implementations such as Hedgehog for Haskell, Hypothesis for Python and test.check for Clojure)

Usage with mocha and jest

import * as QC from 'proptest'
const property = QC.createProperty(it)

describe('f', () => {
  property(
    'is commutative',
    QC.nat.two(),
    ([x, y]) => (expect(f(x, y)).toEqual(f(y, x)), true)
  )
})

(to be improved; remove returning a boolean: discussion)

Usage with tape

import * as QC from 'proptest'
const check = QC.adaptTape(test)

check('f commutative', QC.nat.two(), ([x, y]) => f(x, y) === f(y, x))

Usage with AVA

import * as QC from 'proptest'
test('f commutative', t => {
  t.true(QC.stdoutForall(QC.nat.two(), ([x, y]) => f(x, y) === f(y, x)))
})

(to be improved, also see ava#1692)

Usage without a library as an assertion

import * as QC from 'proptest'
QC.assertForall(QC.nat.two(), ([x, y]) => f(x, y) === f(y, x))

The API exports a function search which return returns {'ok': true} if the property passed or {'ok': false} and the counterexample (or other information) if it did not.

Installation

You can grab it from npm:

npm i -D proptest

You may use yarn:

yarn add --dev proptest

Contributors

Ongoing discussions

  • Should properties return a boolean of success or just not throw an assertion? #6 #5

License

MIT