futil

A collection of F(unctional) Util(ities). Resistance is futile.

Mostly, these are generic utilities that could conceivably be part of a library like lodash/fp, but for some reason or other are not.

Version History/Changelog

See our changelog

Installing

npm i -S futil-js

This package requires lodash/fp, so make sure that's available in your app.

Usage

import * as f from futil-js or import {x,y,z} from futil-js

The syntax: import f from futil-js is not currently supported.

API

Function

maybeCall

(fn, a, b) -> fn(a, b) If fn is a function, call the function with the passed-in arguments. Otherwise, return false.

callOrReturn

(fn, a, b) -> fn(a, b) If fn is a function, call the function with the passed-in arguments. Otherwise, return fn.

boundMethod

(a, Monoid f) -> f[a] :: f a Binds a function of an object to it's object.

converge

http://ramdajs.com/docs/#converge

comply (alias: composeApply)

(f, g) => x => f(g(x))(x) A combinator that combines compose and apply

Logic

overNone

([f, g]) -> !f(x) && !g(x) Creates a function that checks if none of the predicates return truthy when invoked with the arguments it receives.

ifElse

http://ramdajs.com/docs/#ifElse + lodash shorthand and f.callOrReturn support

when

http://ramdajs.com/docs/#when + lodash shorthand and f.callOrReturn support

unless

http://ramdajs.com/docs/#unless + lodash shorthand and f.callOrReturn support

whenTruthy

when curried with Boolean

whenExists

when curried with exists

Collection

flowMap

...fns:functions -> map:function Runs a map function that runs a flow of the functions passed in to this method.

findApply

f -> x -> f(find(f, x)) A version of find that also applies the predicate function to the result. Useful in gets

Lodash Conversions

These are conversions of lodash fp methods.

Ins (Rearg False)

getIn, includesIn, pickIn lodash/fp is great, but sometimes the curry order isn't exactly what you want. These methods provide alternative orderings that are sometimes more convenient. The idea of In methods is to name them by convention, so when ever you need a method that actually takes the collection first (e.g. a get where the data is static but the field is dynamic), you can just add In to the end (such as getIn which takes the object first)

Ons (Immutable False)

extendOn, defaultsOn lodash/fp likes to keep things pure, but sometimes JS can get pretty dirty. These methods are alternatives for working with data that--for whatever the use case is--needs to be mutable Any methods that interact with mutable data will use the On convention (as it is some action occuring On some data)

Array

compactJoin

join:string -> data:array -> result:string Joins an array after compacting.

dotJoin

data:array -> result:string Compacts and joins an array with '.'

repeated

data:array -> result:array Returns an array of elements that are repeated in the array.

mergeRanges

([[], [], []]) -> [[], []] Takes any number of ranges and return the result of merging them all.

Example: [[0,7], [3,9], [11,15]] -> [[0,9], [11,15]]

insertAtIndex

insertAtIndex -> (index, val, string) -> string Insert a string at a specific index.

Example: (1, '123', 'hi') -> 'h123i'

push

(val, array) -> array Return the array with the val pushed

cycle

[a, b...] -> a -> b Creates a function that always return the element next to the one received, based on an input previously received.

Object

singleObject

(k, v) -> {k: v} Creates an object with a key and value.

singleObjectE

(v, k) -> {k: v} Flipped version of singleObject.

chunkObject

({a, b}) -> [{a}, {b}] Breaks an object into an array of objects with one key each.

compactObject

Remove properties with falsey values.

Example: ({ a: 1, b: null, c: false }) -> {a:1}

isEmptyObject:

Check if the variable is an empty object ({}).

isNotEmptyObject:

Check if the variable is not an empty object ({}).

stripEmptyObjects

Omit properties whose values are empty objects.

Example: { a:1, b:{}, c:2 } -> {a:1, c:2} (TODO remame to omitEmptyObjects)

compareDeep

Checks if an object's property is equal to a value.

matchesSignature

Returns true if object keys are only elements from signature list. (but does not require all signature keys to be present)

pickInto

TODO

renameProperty

from:string -> to:string: -> target:object -> result:object Rename a property on an object.

Example: renameProperty('a', 'b', {a:1}) -> {b:1)

unwind

Just like mongo's $unwind.

Example: { x:['a','b'], y:1 } -> [{ x:'a', y:1 }, { x:'b', y:1 }]

flattenObject

Flatten an object with the paths for keys.

Example: { a: { b: { c: 1 } } } => { 'a.b.c' : 1 }.

unflattenObject

Unlatten an object with the paths for keys.

Example: { 'a.b.c' : 1 } => { a: { b: { c: 1 } } }.

mapProp

Deprecated in favor of lodash update Applies a map function at a specific path

Example: mapProp(double, 'a', {a: 2, b: 1}) -> {a: 4, b: 1}.

getOrReturn

_.get that returns the target object if lookup fails

alias

_.get that returns the prop if lookup fails

aliasIn

Flipped alias

cascade

A _.get that takes an array of paths and returns the value at the first path that matches

cascadeIn

Flipped cascade

cascadeKey

A _.get that takes an array of paths and returns the first path that matched

String

parens

'asdf' -> '(asdf)' Wraps a string in parenthesis.

Regex

testRegex

regex -> string -> bool Just like ramda test, creates a function to test a regex on a string.

makeRegex

options:string -> string -> regex A curried implementation of RegExp construction.

makeAndTest

options:string -> string -> (string -> bool) Makes and tests a RegExp with makeRegex and testRegex.

matchAnyWord

string -> string -> bool Returns true if the second string matches any of the words in the first string.

matchAllWords

string -> string -> bool Returns true if the second string matches all of the words in the first string.

postings

regex -> string -> [Range:[number, number]] Returns an array of postings (position ranges) for a regex and string to test.

highlight

start:string -> end:string -> postings:[Range:[number, number]] -> input:string -> string Highlights postings in a string wrapping in start and end.

Example: ('<b>', '<b>', [[0,1]], 'hi') -> '<b>h</b>i'

Math

greaterThanOne

number -> bool Returns true if number is greater than one.

Lang

Language level utilities

throws

Just throws whatever it is passed.

exists (alias: isNotNil)

Negated _.isNil

isMultiple

Returns true if the input has a length property > 1, such as arrays, strings, or custom objects with a lenth property

append

A curried, flipped add

Algebras or composable/recursive data types

map

map :: (a -> b) -> [a] -> [b] Maps a function over an iterable. Works by default for Arrays and Plain Objects.

deepMap

deepMap :: (a -> b) -> [a] -> [b] Maps a function over a recursive iterable. Works by default for nested Arrays, nested Plain Objects and mixed nested Arrays and Plain Objects. Also works for any other iterable data type as long as two other values are sent: a mapping function, and a type checker (See the unit tests for deepMap).

Lens

A lens is a getter and setter pair, which can be used to interface to some part of an object graph. Methods that operate on lenses can encapsulate common operations independent of knowledge of their surrounding context. Unlike some traditional functional lenses (like Ramda's), the set methods here are generally mutable.

An object lens is simply an object that has a get and set function. An example of this is a mobx boxed observable.

A function lens is a lense expressed as a single function that takes the value to set or returns the current value if nothing is passed. Examples of this in the wild are knockout observables and jquery plugin api style methods.

The utilities in this library expect can accept either kind of lens, and utilities are provided to seamless convert between the two.

Stubs

Lens stubs are primarily a reference implementation, but are useful for testing and mocking purposes

functionLens

Takes a value and returns a function lens for that value

objectLens

Takes a value and returns a object lens for that value

Lens Conversions

Methods to convert between lens types

fnToObj

Converts a function lens an object lens

objToFn

Converts an object lens to a function lens

Lens Construction

This the first main way you'll generally interact with the lens API

lensProp

lensProp :: string -> object -> { get: () -> T, set: T -> T } Creates an object lens for a given property on an object. .get returns the value at that path and set places a new value at that path

lensOf

{a: T, b: T} -> {a:ObjectLens, b:ObjectLens} Takes an object and returns an object with lenses at the values of each path. Basically mapValues(lensProp).

Lens Manipulation

view

Lens -> T Gets the value of the lens, regardless of if it's a function or object lens

views

Lens -> (() -> T) Returns a function that gets the value of the lens, regardless of if it's a function or object lens

set

T -> Lens -> T Sets the value of the lens, regardless of if it's a function or object lens

sets

Creates a function that will set a lens with the provided value

flip

Takes a lens and negates its value

on

Returns a function that will set a lens to true

off

Returns a function that will set a lens to false

Aspect

Aspects provide a functional oriented implementation of Aspect Oriented Programming. An aspect wraps a function and allows you run code at various points like before and after execution. Notably, aspects in this library allow you to have a shared state object between aspects and are very useful for automating things like status indicators, etc on functions.

There is a lot of prior art in the javascript world, but most of them assume a vaguely object oriented context. The implementation in futil-js is done in just 20 lines of code and seems to capture all of the use cases of AOP.

Note: To do OO style AOP with this these aspects, just use lodash's _.update method and optionally boundMethod from futil if this matters

Caveat: While you can and should compose (or _.flow) aspects together, don't put non aspects in the middle of the composition. Aspects rely on a .state property on the wrapped function that they propagate through, but the chain will break if a non-aspect is mixed in between. Additionally, if you need external access to the state, make sure the aspects are the outer most part of the composition so the .state property will be available on the result of the composition.

aspect

aspect: {options} -> f -> () The aspect api takes an options object and returns a function which takes a function to wrap. The wrapped function will be decorated with a state object and should referentially transparent (e.g. it can be called in the same way as the function it's replacing).

Options supports the following parameters:

Example Usage:

let exampleAspect = aspect({
  before: () => console.log('pre run'),
  after: () => console.log('post run')
})
let f = () => console.log('run')
let wrapped = exampleAspect(f)
wrapped()
// Logs to the console:
// pre run
// run
// post run

aspects

There are a few basic aspects included because they seem to be universally useful. All of the provided aspects take an extend function to allow customizing the state mutation method (e.g. in mobx, you'd use extendObservable). If null, they default to defaultsOn from futil-js - check the unit tests for example usage.

logs

Logs adds a logs array to the function state and just pushes in results on each run

error

Captures any exceptions thrown and set it on an error error it puts on state

errors

Captures any exceptions thrown and pushes them sequentially into an errors array it puts on state

status

Adds a processing flag that is set to true before the wrapped function runs and false when it's done

concurrency

Prevents a function from running if it's state has processing set to true at the time of invocation