jasmine-static-land

jasmine-static-land

A package for testing the compatability of your Static land types against it's laws within Jasmine

Installing

npm install i -D jasmine-static-land

Getting Started

First you need to load the package which contains a custom matcher

const JSL = require('jasmine-static-land')

Then register it with any test suite you want to use it in:

describe('Cat', function(){
	beforeEach(function(){
		jasmine.addMatchers(JSL)
	})
})

Once registered, you may use any matcher exposed in the Api:

const cat = require('cat')
it('can impliment Foldable, Monad and Chain', function(){
	expect(cat).toBeDefined()
	expect(cat).toBeFoldable()
	expect(cat).toBeMonad()
	expect(cat).toBeChain()
})

Shorthand functions

You can also use the JSL.it() as a shorthand to specify a list of definitions for each type

const dog = require('dog')
describe('Dog', function(){
	JSL.it(['Foldable', 'Monad', 'Chain'], dog)
})

There is also the ability to automatically test types based on the functions they define using JSL.all():

const animals = require('animal-types')
describe('Animals', function(){
	JSL.all(animals) // { Cat: ... , Dog: ... , Ferret: ... }
})

(Warning: Use at your own risk, this can be useful for sanity checking but it won't be able to know which functions should be implimented, only if they are lawful)

Matchers

Refer to the Static Land Spec for a more complete breakdown of the laws being tested.

• toBeSetoid()
• toBeSemigroup()
• toBeMonoid()
• toBeFunctor()
• toBeBifunctor()
• toBeProfunctor()
• toBeApply()
• toBeApplicative()
• toBeChain()
• toBeChainRec()
• toBeMonad()
• toBeFoldable()
• toBeExtend()
• toBeComonad()
• toBeTraversable()