node package manager
We need your input. Help make JavaScript better: Take the 2017 JavaScript Ecosystem survey »

@zkat/fl-protocols

Fantasyland Protocols

This module provides a fantasy-land compatibility layer using protocols. The compatibility layer includes protocol definitions for all protocols with methods listed in the fantasy-land spec, and includes automatic two-way compatibility between methods defined in either world.

That is: you can use protocol functions exported by fl-protocols on any object(s) that have fantasy-land methods implemented, without any extra work, and and methods you define using fl-protocols will automatically become available to fantasy-land users even if they are not directly using fl-protocols.

Even multiple-dispatched protocols will work two-ways, so fl-protocols is a great way to augment your fantasy-land implementations!

Example

// Basic two-way compatibility
> var flp = require('@zkat/fl-protocols')
> var fl = require('fantasy-land')
> var Monoid = require('@zkat/fl-protocols/monoid')
 
> Monoid([Number], { empty: () => 0 })
 
> flp.empty(1)
0
> Number(1)[fl.empty]()
0
> var obj = { [fl.empty]: () => ({}) }
 
> flp.empty(obj)
{}
> Monoid.empty(obj)
{}
 
// Multiple dispatch on fl methods
> var Setoid = require('@zkat/fl-protocols/setoid')
undefined
> Setoid([Number, String], {
    equals: (n, s) => n === parseFloat(s)
  })
> Setoid([String, Number], {
    equals: (s, n) => parseFloat(s) === n
  })
> Number(5)[fl.equals]("5")
true
> String("1")[fl.equals](1)
true