Global

Methods

allToLower(values) → {Array.<string>}

Description:

• Converts all elements in an array to lowercase. Each element is coerced into a String, if it's not already one. All undefined and null values will be removed from the output.

Source:

• all-to-lower-upper.js, line 21

Example

allToLower(['Foo', null, 'bAr']); // ['foo', bar']

Parameters:

Returns:

Type

Array.<string>

allToUpper(values) → {Array.<string>}

Description:

• Converts all elements in an array to uppercase. Each element is coerced into a String, if it's not already one. All undefined, null or empty values will be removed from the output.

Source:

• all-to-lower-upper.js, line 36

Example

allToUpper(['Foo', null, 'bAr']); // ['FOO', BAR']

Parameters:

Returns:

Type

Array.<string>

alwaysNew(value) → {function}

Description:

• Returns a function that creates new instances of whatever argument is passed in each time it's called.

Source:

• always-new.js, line 19

Example

const alwaysNewArray = alwaysNew([]);
 const a = alwaysNewArray(); // -> []
 const b = alwaysNewArray(); // -> []
 // a !== b

Parameters:

Returns:

Type

function

applySpec(spec) → {function}

Description:

• Given a spec object recursively mapping properties to functions, creates a function producing an object of the same structure, by mapping each property to the result of calling its associated function with the supplied arguments.

  The difference between R.applySpec and this implementation is that it also accepts literal values as part of the spec (e.g. applySpec({ value: 42 });).

Source:

• apply-spec.js, line 50

Example

const getMetrics = applySpec({
       list: [R.add, 'value']
       sum: R.add,
       some: 'value',
       nested: { mul: R.multiply, any: 'value' }
     });
     getMetrics(2, 4); // => {  list: [6, 'value'], sum: 6, some: 'value', nested: { mul: 8, any: 'value' } }

Parameters:

Returns:

Type

function

arrayPath(path, obj) → {Array.<*>}

Description:

• Shorthand function to extract a property at a path from an object and cast its value to an array. If the value is already an array, it will be returned as is. Note that this function ensures that the returned value is always an Array - so null and undefined property values at path will return [null] and [undefined] respectively. Use compactPath instead if you need all falsey and empty values removed.

Source:

• array-path.js, line 25

See:

• https://ramdajs.com/docs/#of
• https://ramdajs.com/docs/#path

Example

arrayPath(['foo', 'bar'], { foo: { bar: 'baz' } }); // -> ['baz']
 arrayPath(['foo'], { foo: [1, 2, 3] }); // -> [1, 2, 3]
 arrayPath(['foo', 'bar'], { foo: {} }); // -> [undefined]

Parameters:

Returns:

Type

Array.<*>

arrayProp(propName, obj) → {Array.<*>}

Description:

• Shorthand function to extract a property from an object and cast its value to an array. If the value is already an array, it will be returned as is. Note that this function ensures that the returned value is always an Array - so null and undefined properties will return [null] and [undefined] respectively. Use compactProp instead if you need all falsey and empty values removed.

Source:

• array-prop.js, line 25

See:

• https://ramdajs.com/docs/#of
• https://ramdajs.com/docs/#prop

Example

arrayProp('foo', { foo: 'bar' }); // -> ['bar']
 arrayProp('foo', { foo: [1, 2, 3] }); // -> [1, 2, 3]
 arrayProp('foo', {}); // -> [undefined]

Parameters:

Returns:

Type

Array.<*>

booleanProp(propName, obj) → {boolean}

Description:

• Shorthand function to extract a property from an object and convert it to a boolean. Parsing of values to boolean follows yn logic.

Source:

• boolean-prop.js, line 36

See:

• https://github.com/sindresorhus/yn#readme
• https://ramdajs.com/docs/#prop

Example

booleanProp('foo', { foo: 'y' }); // -> true
 booleanProp('foo', { foo: 0 }); // -> false

Parameters:

Returns:

Type

boolean

booleanPropOr(defaultValue, propName, obj) → {*}

Description:

• Shorthand function to extract a property from an object and convert it to a Boolean. If boolean conversion would return null or undefined, it returns defaultValue, instead.

Source:

• boolean-prop.js, line 55

See:

• https://github.com/sindresorhus/yn#readme
• https://ramdajs.com/docs/#propOr

Example

booleanPropOr(true, 'foo', { bar: 42 }); // -> true
 booleanPropOr(false, 'foo', { foo: 'y' }); // -> true

Parameters:

Returns:

Type

*

capitalize(str) → {string}

Description:

• Transforms a string so that the first letter is capitalized and the rest is lowercased (i.e.: 'uNibROw' -> 'Unibrow'). If the input is null or undefined, it's returned as is.

Source:

• capitalize.js, line 12

Parameters:

Returns:

Type

string

capitalizeWords(words) → {string}

Description:

• Capitalizes each word in a sentence. A "word" is considered any token between space characters.

Source:

• capitalize-words.js, line 17

Example

capitalizeWords('I am selling these fine leather jackets');
 // I am Selling These Fine Leather Jackets

Parameters:

Returns:

Type

string

castArray(value) → {Array}

Description:

• Wraps any value in an Array if it's not already one.

Source:

• cast-array.js, line 17

See:

• https://ramdajs.com/docs/#of

Example

castArray(42); // -> [42]
 castArray([42]); // -> [42]
 castArray(['foo', 'bar']); // -> ['foo', 'bar']

Parameters:

Returns:

Type

Array

coalesce(fns) → {function}

Description:

• Creates a wrapping function that concatenates the result of each function in fns with an || operator, returning the first truthy value. This works as a falsy-coalescing operator.

Source:

• coalesce.js, line 30

See:

• https://ramdajs.com/docs/#either

Example

coalesce([prop('foo'), prop('bar'), prop('baz')])({ bar: 42 }); // -> 42

Parameters:

Returns:

Type

function

compact(list) → {Array.<*>}

Description:

• Returns a new array with all falsey and empty values removed. The values false, null, 0, "", undefined, and NaN are falsey. [] and {} are considered empty.

Source:

• compact.js, line 18

See:

• https://lodash.com/docs/4.17.11#compact
• https://ramdajs.com/docs/#filter

Example

compact([0, 1, false, 2, '', 3, {}]);
 // -> [1, 2, 3]

Parameters:

Returns:

Type

Array.<*>

compactPath(path, obj) → {Array.<*>}

Description:

• Shorthand function to extract a property from an object at path and cast its value to an array, removing all falsey and empty values from it. The values false, null, 0, "", undefined, and NaN are falsey. [] and {} are considered empty. If the value is already an array, this function behaves like calling compact with that same value. Note that this function ensures that the returned value is always an Array - so null and undefined properties will both return [] (an empty array).

Source:

• array-path.js, line 50

See:

• https://ramdajs.com/docs/#of
• https://ramdajs.com/docs/#path

Example

compactPath(['foo'. 'bar'], { foo: { bar: 'baz' } }); // -> ['baz']
 compactPath(['foo'], { foo: [0, 1, 2, 3, null] }); // -> [1, 2, 3]
 compactPath(['foo', 'bar'], {}); // -> []
 compactPath(['foo'], { foo: null }); // -> []
 compactPath(['foo', 'bar'], { foo: {} }); // -> []

Parameters:

Returns:

Type

Array.<*>

compactProp(propName, obj) → {Array.<*>}

Description:

• Shorthand function to extract a property from an object and cast its value to an array, removing all falsey and empty values from it. The values false, null, 0, "", undefined, and NaN are falsey. [] and {} are considered empty. If the value is already an array, this function behaves like calling compact with that same value. Note that this function ensures that the returned value is always an Array - so null and undefined properties will both return [] (an empty array).

Source:

• array-prop.js, line 50

See:

• https://ramdajs.com/docs/#of
• https://ramdajs.com/docs/#prop

Example

compactProp('foo', { foo: 'bar' }); // -> ['bar']
 compactProp('foo', { foo: [0, 1, 2, 3, null] }); // -> [1, 2, 3]
 compactProp('foo', {}); // -> []
 compactProp('foo', { foo: null }); // -> []
 compactProp('foo', { foo: {} }); // -> []

Parameters:

Returns:

Type

Array.<*>

compactSpec(spec, value) → {object|undefined}

Description:

• Given a spec object recursively mapping properties to functions, creates a function producing an object of the same structure, by mapping each property to the result of calling its associated function with the supplied arguments. If the outcome of applying the spec produces an object with all nil or empty values, it returns undefined instead.

Source:

• compact-spec.js, line 20

See:

• https://ramdajs.com/docs/#applySpec

Example

compactSpec({ foo: o => o.bar }, { bar: null }); // -> undefined

Parameters:

Returns:

Type

object | undefined

curry(fn) → {function}

Description:

• Returns a curried equivalent of the provided function. The curried function has two unusual capabilities. First, its arguments needn't be provided one at a time. If f is a ternary function and g is curry(f), the following are equivalent:

  • g(1)(2)(3)
  • g(1)(2, 3)
  • g(1, 2)(3)
  • g(1, 2, 3)

  Secondly, the special placeholder value R.__ (exported by ramda) may be used to specify "gaps", allowing partial application of any combination of arguments, regardless of their positions. If g is as above and _ is R.__, the following are equivalent:

  • g(1, 2, 3)
  • g(_, 2, 3)(1)
  • g(_, _, 3)(1)(2)
  • g(_, _, 3)(1, 2)
  • g(_, 2)(1)(3)
  • g(_, 2)(1, 3)
  • g(_, 2)(_, 3)(1)

Source:

• curry.js, line 40

Example

const addFourNumbers = (a, b, c, d) => a + b + c + d;

     const curriedAddFourNumbers = R.curry(addFourNumbers);
     const f = curriedAddFourNumbers(1, 2);
     const g = f(3);
     g(4); //=> 10

Parameters:

Returns:

Type

function

curryN(length, fn) → {function}

Description:

• Returns a curried equivalent of the provided function, with the specified arity. The curried function has two unusual capabilities. First, its arguments needn't be provided one at a time. If g is R.curryN(3, f), the following are equivalent:

  • g(1)(2)(3)
  • g(1)(2, 3)
  • g(1, 2)(3)
  • g(1, 2, 3)

  Secondly, the special placeholder value R.__ may be used to specify "gaps", allowing partial application of any combination of arguments, regardless of their positions. If g is as above and _ is R.__, the following are equivalent:

  • g(1, 2, 3)
  • g(_, 2, 3)(1)
  • g(_, _, 3)(1)(2)
  • g(_, _, 3)(1, 2)
  • g(_, 2)(1)(3)
  • g(_, 2)(1, 3)
  • g(_, 2)(_, 3)(1)

Source:

• curry-n.js, line 43

Example

const sumArgs = (...args) => R.sum(args);

     const curriedAddFourNumbers = R.curryN(4, sumArgs);
     const f = curriedAddFourNumbers(1, 2);
     const g = f(3);
     g(4); //=> 10

Parameters:

Returns:

Type

function

interpolate(template, context) → {string}

Description:

• Replaces variables in a template enclosed by {}.

Source:

• interpolate.js, line 25

Example

interpolate('I am {name}', { name: 'Error' });
 // 'I am Error'

Parameters:

Returns:

Type

string

isNilOrEmpty(value) → {boolean}

Description:

• Checks whether the given value is null, undefined or empty (definition of "empty" is type dependant).

Source:

• is-nil-empty.js, line 21

See:

• https://ramdajs.com/docs/#isNil
• https://ramdajs.com/docs/#isEmpty

Example

isNilOrEmpty({}); // -> true
 isNilOrEmpty(null); // -> true
 isNilOrEmpty([]); // -> true
 isNilOrEmpty(''); // -> true
 isNilOrEmpty([42]); // -> false

Parameters:

Returns:

Type

boolean

isNotEmpty(value) → {boolean}

Description:

• Checks whether the given value is not empty or not (definition of "empty" is type dependant).

Source:

• is-nil-empty.js, line 78

See:

• https://ramdajs.com/docs/#isEmpty

Example

isNotEmpty({}); // -> false
 isNotEmpty(null); // -> true
 isNotEmpty(undefined); // -> true
 isNotEmpty([]); // -> false
 isNotEmpty([42]); // -> true
 isNotEmpty(''); // -> false

Parameters:

Returns:

Type

boolean

isNotNil(value) → {boolean}

Description:

• Checks whether the given value is neither null, nor undefined.

Source:

• is-nil-empty.js, line 58

See:

• https://ramdajs.com/docs/#isNil

Example

isNotNil({}); // -> true
 isNotNil(null); // -> false
 isNotNil([42]); // -> true
 isNotNil(undefined); // -> false
 isNotNil(''); // -> true

Parameters:

Returns:

Type

boolean

isNotNilOrEmpty(value) → {boolean}

Description:

• Checks whether the given value is neither null, undefined nor empty (definition of "empty" is type dependant).

Source:

• is-nil-empty.js, line 41

See:

• https://ramdajs.com/docs/#isNil
• https://ramdajs.com/docs/#isEmpty

Example

isNotNilOrEmpty({}); // -> false
 isNotNilOrEmpty(null); // -> false
 isNotNilOrEmpty([]); // -> false
 isNotNilOrEmpty(''); // -> false
 isNotNilOrEmpty([42]); // -> true

Parameters:

Returns:

Type

boolean

isNotOneOf(firstSet, secondSet) → {boolean}

Description:

• Checks if a string value (or set of values) is not present in another. The comparison between elements is case insensitive. null and undefined values are ignored.

Source:

• is-one-of.js, line 48

See:

• https://ramdajs.com/docs/#intersection

Example

const isNotVeggie = isNotOneOf(['carrot', 'cucumber', 'parsnip']);
 isNotVeggie('tuna'); //=> true

 const areAllDomestic = isNotOneOf(['tiger', 'lion', 'panther']);
 areAllDomestic(['dog', 'cat']); //=> true
 areAllDomestic(['tiger', 'cat']); //=> false

Parameters:

Returns:

Type

boolean

isOneOf(firstSet, secondSet) → {boolean}

Description:

• Checks if a string value (or set of values) is present in another. The comparison between elements is case insensitive. null and undefined values are ignored.

Source:

• is-one-of.js, line 24

See:

• https://ramdajs.com/docs/#intersection

Example

const isVeggie = isOneOf(['carrot', 'cucumber', 'parsnip']);
 isVeggie('tuna'); //=> false

 const anyWild = isOneOf(['tiger', 'lion', 'panther']);
 anyWild(['dog', 'cat']); //=> false
 anyWild(['tiger', 'cat']); //=> true

Parameters:

Returns:

Type

boolean

joinFrom(separator, fns, elem) → {string}

Description:

• Joins together using a separator strings returned from an array of fns functions that are applied to an obj element.

Source:

• join-from.js, line 22

Example

joinFrom('-', [prop('firstName'), prop('lastName')], {
   firstName: 'Fred',
   lastName: 'Astaire'
 }); // -> Fred Astaire

Parameters:

Returns:

Type

string

lowerEquals(first, second) → {boolean}

Description:

• Compares two elements and returns true if they are the same after transforming their stringified value to lower case and trimming spaces; false otherwise.

Source:

• lower-equals.js, line 16

See:

• https://ramdajs.com/docs/#eqBy

Parameters:

Returns:

Type

boolean

lowerPath(path, obj) → {*}

Description:

• Extracts the value of an object at the given path. The individual keys on the path are transformed to lowercase before extracting the actual value.

Source:

• lower-path.js, line 17

See:

• https://ramdajs.com/docs/#path

Example

lowerPath(['country', 'IE'], {country: { ie: '�' } });
 // -> '�'

Parameters:

Returns:

Type

*

lowerPathSatisfies(pred, path, obj) → {boolean}

Description:

• Returns true if the specified object property at given path satisfies the given predicate; false otherwise. The individual keys on the path are transformed to lowercase before checking the actual value.

Source:

• lower-path-satisfies.js, line 19

See:

• https://ramdajs.com/docs/#pathSatisfies

Example

lowerPathSatisfies(isNil, ['country', 'IE'], {country: { ie: '�' } });
 // -> false

Parameters:

Returns:

Type

boolean

lowerTrim(value) → {string}

Description:

• Trims and transforms text to lower case. null and undefined values are returned as is.

Source:

• lower-trim.js, line 11

Parameters:

Returns:

Type

string

mapKeys(fn, obj) → {object}

Description:

• Map keys on an objects by running a mapping function to each one.

Source:

• map-keys.js, line 12

Parameters:

Returns:

Type

object

mergeInto(propNames, arrayPropName, obj) → {object}

Description:

• Given an object containing an array move selected properties outside the array to each element on it.

Source:

• merge-into.js, line 33

Example

const o = { foo: 'bar', items: [{ id: 1 }, { id: 2 }] };
 mergeInto('foo', 'items');
 // -> { foo: 'bar', items: [{ id: 1, foo: 'bar' }, { id: 2, foo: 'bar' }] }

Parameters:

Returns:

Type

object

mergeSpec(spec, obj) → {object}

Description:

• Recursively applies functions on the spec object to produce a new object matching its definition, which is then merged with the original object. If a key exists in both objects, the value from the result of applying the spec will take precedence.

Source:

• merge-spec.js, line 26

See:

• https://ramdajs.com/docs/#applySpec
• https://ramdajs.com/docs/#mergeRight

Example

mergeSpec({ bar: o => o.num + 40 }, { num: 2 });
 // -> { bar: 42, num: 2 }

Parameters:

Returns:

Type

object

nAry(n, fn) → {function}

Description:

• Wraps a function of any arity (including nullary) in a function that accepts exactly n parameters. Any extraneous parameters will not be passed to the supplied function.

Source:

• n-ary.js, line 26

Example

const takesTwoArgs = (a, b) => [a, b];

     takesTwoArgs.length; //=> 2
     takesTwoArgs(1, 2); //=> [1, 2]

     const takesOneArg = R.nAry(1, takesTwoArgs);
     takesOneArg.length; //=> 1
     // Only `n` arguments are passed to the wrapped function
     takesOneArg(1, 2); //=> [1, undefined]

Parameters:

Returns:

Type

function

notEquals(A, B) → {boolean}

Description:

• Returns false if its arguments are equivalent, true otherwise. Handles cyclical data structures.

Source:

• not-equals.js, line 16

See:

• https://ramdajs.com/docs/#complement
• https://ramdajs.com/docs/#equals

Example

notEquals(1, 2) //=> true
  notEquals({ a: 1 }, { a: 1 }) //=> false

Parameters:

Returns:

Type

boolean

numberPath(propPath, obj) → {number}

Description:

• Shorthand function to extract a nested property from an object and convert it to a number. Note that this behaves somewhat different to regular number parsing using Number constructor: if the property is null or undefined it will be returned as is; if the property is an empty string (''), NaN will be returned.

Source:

• number-prop.js, line 59

See:

• https://ramdajs.com/docs/#path

Example

numberPath(['life', 'meaning'], { life: { meaning: '42' }}); // 42

Parameters:

Returns:

Type

number

numberPathOr(defaultValue, propPath, obj) → {*}

Description:

• Extract a nested property from an object and convert it to a number. If property is absent, null, undefined or cannot be coerced into a Number, the default value will be returned instead. Note that number coercing behaves somewhat different than using the Number constructor: an empty string ('') or null would return the defaultValue instead of 0.

Source:

• number-prop.js, line 104

See:

• https://ramdajs.com/docs/#pathOr

Example

numberPathOr(42, ['life', 'meaning'], { foo: 'bar' }); // 42

Parameters:

Returns:

Type

*

numberProp(propName, obj) → {number}

Description:

• Shorthand function to extract a property from an object and convert it to a number. Note that this behaves somewhat different to regular number parsing using Number constructor: if the property is null or undefined it will be returned as is; if the property is an empty string (''), NaN will be returned.

Source:

• number-prop.js, line 41

See:

• https://ramdajs.com/docs/#prop

Parameters:

Returns:

Type

number

numberPropOr(defaultValue, propName, obj) → {*}

Description:

• Extract a property from an object and convert it to a number. If property is absent, null, undefined or cannot be coerced into a Number, the default value will be returned instead. Note that number coercing behaves somewhat different than using the Number constructor: an empty string ('') or null would return the defaultValue instead of 0.

Source:

• number-prop.js, line 80

See:

• https://ramdajs.com/docs/#propOr

Parameters:

Returns:

Type

*

propOf(obj, propName) → {*}

Description:

• Returns the value of obj at the given propName.

Source:

• prop-of.js, line 17

See:

• https://ramdajs.com/docs/#flip
• https://ramdajs.com/docs/#prop

Example

propOf({ name: 'Alexander' }, 'name') //=> 'Alexander'
  propOf({ name: 'Alexander' }, 'age') //=> undefined

Parameters:

Returns:

Type

*

rejectNil(functor) → {object|Object}

Description:

• Iterates over a functor a removes any elements that are either null or undefined.

Source:

• reject-nil.js, line 19

See:

• https://ramdajs.com/docs/#reject

Example

rejectNil(null); // -> null
 rejectNil([42, undefined, 'life']); // -> [42, 'life']
 rejectNil({ foo: null, life: 42 }); // -> { life: 42 }

Parameters:

Returns:

Type

object | Object

rejectNilOrEmpty(functor) → {object|Object}

Description:

• Iterates over a functor a removes any elements that are either null, undefined. or empty ([], {}).

Source:

• reject-nil.js, line 36

See:

• https://ramdajs.com/docs/#reject

Example

rejectNilOrEmpty(null); // -> null
 rejectNilOrEmpty([42, undefined, {}, 'life']); // -> [42, 'life']
 rejectNilOrEmpty({ foo: null, bar: [], life: 42 }); // -> { life: 42 }

Parameters:

Returns:

Type

object | Object

renameKeys(keysMap, obj) → {object}

Description:

• Creates a new object with the own properties of the provided object, but the keys renamed according to the keysMap object as {oldKey: newKey}. When some key is not found in the keysMap, then it's passed as-is.

Source:

• rename-keys.js, line 17

See:

• https://github.com/ramda/ramda/wiki/Cookbook#rename-keys-of-an-object

Example

renameKeys({ foo: 'life' }, { foo: 42 }); // -> { life: 42 }

Parameters:

Returns:

Type

object

round(decimals, value) → {number}

Description:

• Rounds a given number to the next largest number for positives and the next smallest for negatives.

Source:

• round.js, line 15

Example

round(2, 2.151) // returns 2.15
round(1, -2.63) // returns -2.7
round(0, 2.8) // returns 3

Parameters:

Returns:

Type

number

spreadProp(prop, obj) → {object}

Description:

• Spreads object under property onto provided object.

Source:

• spread-prop.js, line 15

See:

• https://char0n.github.io/ramda-adjunct/2.10.0/RA.html#.spreadProp

Example

spreadProp('b', { a: 1, b: { c: 3, d: 4 } }); // => { a: 1, c: 3, d: 4 };

Parameters:

Returns:

Type

object

stringPath(propPath, obj) → {string}

Description:

• Shorthand function to extract a nested property from an object and convert it to a string. If the property is null or undefined it will be returned as is; if the property is an empty string (''), null will be returned.

Source:

• string-prop.js, line 56

See:

• https://ramdajs.com/docs/#path

Example

stringPath(['life', 'count'], { life: { count: 1 }}); // '1'

Parameters:

Returns:

Type

string

stringPathOr(defaultValue, propPath, obj) → {*}

Description:

• Extract a nested property from an object and convert it to a string. If property is absent, null, undefined or empty, the default value will be returned instead.

Source:

• string-prop.js, line 94

See:

• https://ramdajs.com/docs/#pathOr

Example

stringPathOr('default', ['life', 'reason'], { foo: 'bar' }); // 'default'

Parameters:

Returns:

Type

*

stringProp(propName, obj) → {string}

Description:

• Shorthand function to extract a property from an object and convert it to a string. If the property is null or undefined it will be returned as is; if the property is an empty string (''), null will be returned.

Source:

• string-prop.js, line 39

See:

• https://ramdajs.com/docs/#prop

Parameters:

Returns:

Type

string

stringPropOr(defaultValue, propName, obj) → {*}

Description:

• Extract a property from an object and convert it to a string. If property is absent, null, undefined or empty, the default value will be returned instead.

Source:

• string-prop.js, line 73

See:

• https://ramdajs.com/docs/#propOr

Parameters:

Returns:

Type

*

sumProp(precision, propName, values) → {number}

Description:

• Sums the values at propName present in each element of an array. Works as a single-pass version of compose(sum, map(Number), pluck(propName)).

Source:

• sum-prop.js, line 21

Example

sumProp(2, 'amount', [{amount:'40'}, {amount:'2'}]); // 42

Parameters:

Returns:

Type

number

thenThrowErrorWith(message, data)

Description:

• Returns a function that, when invoked, throws an Error with the given message extended with additional properties on data.

Source:

• throw-error.js, line 37

Example

const explode = thenThrowErrorWith('boom', { code: 500 });
 explode(); // Throw `new Error('boom')`

Parameters:

Throws:

throwErrorWith(message, data)

Description:

• Immediately throws an Error with the given message extended with additional properties on data.

Source:

• throw-error.js, line 22

Example

throwErrorWith('boom', { code: 500 }); // Throw `new Error('boom')`

Parameters:

Throws:

truncate(maxLength, value) → {string}

Description:

• Truncates the given string value so its total length does not exceed maxLength length, adding an ellipsis (...) at the end.

Source:

• truncate.js, line 54

Example

truncate(15, 'I am selling these fine leather jackets');
 // 'I am selling...'

Parameters:

Returns:

Type

string