Package Exports
- lodash-decipher
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (lodash-decipher) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
lodash-decipher
A smattering of mixins for LoDash, by [Decipher, Inc.] (http://decipherinc.com).
Install
$ bower install lodash-decipheror
$ npm install lodash-decipherThen, add a <script> tag, or require('lodash-decipher') or whatever is applicable.
lodash-decipher is a UMD module.
Chainable Methods
_.transmogrify(value, func, [ignoreRx])
Walk an object depth-first and execute a function against each member, replacing the value of that member with the value returned by the function. Use _.applicator to generate a function which will call a function within each object member, if present. Will not walk functions.
Parameters
value: Object, Object to walk.
func: Function, Function to execute against each member.
ignoreRx: RegExp | string, Any key matching this will not be walked.
Returns: *, Transmogrified copy of your object.
Example:
// Given a deeply-nested object `foo`, return a deeply-nested object
// wherein all members are converted to strings via their `toString()` methods.
var bar = _.transmogrify(foo, _.applicator('toString'));
// Given a deeply-nested object `foo`, return a deeply-nested object
// wherein all array members are converted to objects, ignoring
// any arrays whose key contains `$`.
var bar = _.transmogrify(foo, function(value) {
if (_.isArray(value)) {
value = _.extend({}, value);
}
return value;
}, '$');_.morph(value, [callback], [thisArg])
Convenience method. Calls _.map or _.mapValues as appropriate on value. If value is not an Array or Object, value will be returned.
Parameters
value: Object | Array, Value to map or mapValues against.
[callback]: Function | Object, Function to execute, or _.pluck-style clause.
[thisArg]: Object, Value of this in the callback.
Returns: *, The morphed value
_.sift(value, [callback], [thisArg])
Convenience method. Calls _.filter or _.pick as appropriate on value. If value is not an Array or Object, value will be returned.
Parameters
value: Object | Array, Value to filter or pick against.
[callback]: Function | Object, Function to execute, or _.pluck-style clause.
[thisArg]: Object, Value of this in the callback.
Returns: *, The sifted value
_.squirt(collection, key, [value])
"Squirts" some key/value pair into each member of an Object or Array. Maybe like the opposite of _.pluck? Dunno.
Parameters
collection: Object | Array, Some thing to iterate over. If not an iterable value, collection will be returned.
key: Object | string, If the (enumerable) item in collection is object-like, use this key to set the value. Alternatively, use an object to set multiple values.
[value]: *, Value to set key to. Applicable only if key is a string.
Returns: *, The squirted collection
Example:
var foo = [{}, {}, {}];
_.squirt(foo, {bar: true}) // [{bar: true}, {bar: true}, {bar: true}]
// equivalent:
var baz = [{}, {}, {}];
_.squirt(foo, 'bar', true) // [{bar: true}, {bar: true}, {bar: true}]_.empty([value])
Empties a value of its enumerable contents.
Parameters
[value]: Object | Array, Value to empty
Returns: *, Emptied value, if it's empty-able.
Example:
var foo = {a: 1, b: 2, c: 3};
_.empty(foo); // {}
var bar = [1, 2, 3];
_.empty(bar); // []_.flattenPrototype(value)
Given an object with a non-trivial prototype chain, return its flattened prototype.
Parameters
value: *, Something with a prototype, hopefully
Returns: Object, A flattened prototype
Non-Chainable Methods
_.applicator([func], [args], [ctx])
Generates a function which accepts a value and returns the result of executing a function against that value.
Parameters
[func]: Function | string, Function to call. If a string, then will atempt to execute a function with the same name within the parameter to the returned function of this function. If omitted, will call _.identity.
[args]: Array, Any arguments to pass to func.
[ctx]: Object, Context to execute func in. Defaults to the parameter to the returned function of this function.
Returns: Function
Example:
var foo = _.applicator('toString');
var bar = 1;
foo(bar); // '1'_.isDefined([value])
Returns true if the value is not undefined.
Parameters
value: *, Value to inspect
Returns: boolean
_.format(value, [params])
Formats a string value, sprintf-style, sort of. Is pretty forgiving. Does not currently support things like decimal places and padding. Valid replacements:
%s: String replacement%d: Integer replacement%f: Float replacement%j: JSON replacement
Parameters
value: string, String to format, which can contain any number of the above replacement variables
params: [string], Any parameters to your formatting string
Returns: string, Formatted string
_.noop()
It's a no-op.
Example:
// nothing happens.
_.noop();
// nothing happens a second later.
setTimeout(function() {
_.noop();
}, 1000);Maintainer
License
MIT