Any

Any Boolean

Any is a Monoid that will combine (2) values of any type using logical disjunction (OR) on their coerced Boolean values, mapping truthy values to true and falsy values to false.

import Any from 'crocks/Any'

import isNumber from 'crocks/predicates/isNumber'
import mconcatMap from 'crocks/helpers/mconcat'

const trueString = Any('string')
const falseString = Any('')
const object = Any({ nice: true })

trueString.concat(falseString)
//=> Any false

trueString.concat(object)
//=> Any true

const anyNumber =
  mconcatMap(Any, isNumber)

anyNumber([ 'string', 3 ])
//=> Any true

anyNumber([ true, 'string' ])
//=> Any false

Construction

Any :: a -> Any Boolean

Any is constructed by calling the constructor with any type a. This will return an Any wrapping the provided value, coerced to a Boolean. For example, providing an non-empty String will result in an Any(true). While passing an empty String results in an Any(false).

import Any from 'crocks/Any'

Any(0)
//=> Any(false)

Any(1)
//=> Any(true)

Any([])
//=> Any(true)

Constructor Methods

empty

Any.empty :: () -> Any

empty provides the identity for the Monoid in that when the value it provides is concated to any other value, it will return the other value. In the case of Any the result of empty is false. empty is available on both the Constructor and the Instance for convenience.

import Any from 'crocks/Any'

Any.empty() //=> Any false

Any(true).concat(Any.empty())   //=> Any true
Any(false).concat(Any.empty())  //=> Any false

Instance Methods

equals

Any a ~> b -> Boolean

Used to compare the underlying values of (2) Any instances for equality by value, equals takes any given argument and returns true if the passed argument is an Any with an underlying value equal to the underlying value of the Any the method is being called on. If the passed argument is not an Any or the underlying values are not equal, equals will return false.

import Any from 'crocks/Any'

Any(true)
  .equals(Any(true))
//=> true

Any(true)
  .equals(Any(false))
//=> false

concat

Any ~> Any -> Any

concat is used to combine (2) Semigroups of the same type under an operation specified by the Semigroup. In the case of Any, it will combine the (2) using logical OR (disjunction).

import Any from 'crocks/Any'

Any(true).concat(Any(true))   //=> Any true
Any(true).concat(Any(false))  //=> Any true
Any(false).concat(Any(true))  //=> Any true
Any(false).concat(Any(false)) //=> Any false

valueOf

Any ~> () -> Boolean

valueOf is used on all crocks Monoids as a means of extraction. While the extraction is available, types that implement valueOf are not necessarily a Comonad. This function is used primarily for convenience for some of the helper functions that ship with crocks. Calling valueOf on an Any instance will result in the underlying Boolean value.

import Any from 'crocks/Any'

Any(0).valueOf()        //=> false
Any('string').valueOf() //=> true

//=> true
Any(45)
  .concat('')
  .valueOf()

Contribute on Github! Edit this section.