Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

utils

Package Overview
Dependencies
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

utils - npm Package Compare versions

Comparing version 0.2.0 to 0.2.1

31

lib/object/reduce.js
'use strict';
module.exports = require('object.reduce');
/**
* Reduces an object to a value that is the accumulated
* result of running each property in the object through a callback.
*
* ```js
* var a = {a: 'foo', b: 'bar', c: 'baz'};
*
* reduce(a, function (acc, value, key, obj) {
* // `acc`- the initial value (or value from the previous callback call),
* // `value`- the of the current property,
* // `key`- the of the current property, and
* // `obj` - original object
*
* acc[key] = value.toUpperCase();
* return acc;
* }, {});
*
* //=> {a: 'FOO', b: 'BAR', c: 'BAZ'};
* ```
*
* @name .reduce
* @param {Object} `obj` The object to iterate over.
* @param {Function} `iterator` Iterator function
* @param {Object} `initial` Initial value.
* @param {Object} `thisArg` The `this` binding of the iterator function.
* @return {Object}
* @api public
*/
module.exports = require('object.reduce');

6

package.json
{
"name": "utils",
"description": "Fast, generic JavaScript/node.js utility functions.",
"version": "0.2.0",
"version": "0.2.1",
"homepage": "https://github.com/jonschlinkert/utils",

@@ -55,3 +55,3 @@ "author": {

"object.pick": "^1.1.1",
"object.reduce": "^0.1.6",
"object.reduce": "^0.1.7",
"right-align": "^0.1.1",

@@ -72,3 +72,3 @@ "word-wrap": "^1.0.2"

"through2": "^0.6.5",
"verb": "^0.5.0",
"verb": "^0.7.0",
"vinyl": "^0.4.6"

@@ -75,0 +75,0 @@ },

395

README.md

@@ -5,3 +5,2 @@ # utils [![NPM version](https://badge.fury.io/js/utils.svg)](http://badge.fury.io/js/utils) [![Build Status](https://travis-ci.org/jonschlinkert/utils.svg)](https://travis-ci.org/jonschlinkert/utils)

## Install with [npm](npmjs.org)

@@ -47,3 +46,2 @@

**Get all utils on one object**

@@ -68,2 +66,3 @@

## API
### [.after](lib/array/after.js#L19)

@@ -73,2 +72,4 @@

**Params**
* `array` **{Array}**: Collection

@@ -78,2 +79,4 @@ * `n` **{Number}**: Starting index (number of items to exclude)

**Example**
```js

@@ -88,5 +91,9 @@ after(['a', 'b', 'c'], 1)

**Params**
* `val` **{*}**
* `returns`: {Array}
* `returns` **{Array}**
**Example**
```js

@@ -104,2 +111,4 @@ arrayify('abc')

**Params**
* `array` **{Array}**

@@ -109,2 +118,4 @@ * `n` **{Number}**

**Example**
```js

@@ -119,5 +130,9 @@ before(['a', 'b', 'c'], 2)

**Params**
* `arr` **{Array}**
* `returns`: {Array}
* `returns` **{Array}**
**Example**
```js

@@ -132,6 +147,10 @@ compact([null, a, undefined, 0, false, b, c, '']);

**Params**
* `a` **{Array}**
* `b` **{Array}**
* `returns`: {Array}
* `returns` **{Array}**
**Example**
```js

@@ -149,7 +168,11 @@ var a = ['a', 'b', 'c', 'd'];

**Params**
* `array` **{Array}**
* `fn` **{Function}**
* `thisArg` **{Object}**: Optionally pass a `thisArg` to be used as the context in which to call the function.
* `returns`: {Array}
* `returns` **{Array}**
**Example**
```js

@@ -171,6 +194,10 @@ each(['a', 'b', 'c'], function (ele) {

**Params**
* `array` **{Array}**
* `n` **{Number}**: Number of items to return, starting at `0`.
* `returns`: {Array}
* `returns` **{Array}**
**Example**
```js

@@ -185,5 +212,9 @@ first(['a', 'b', 'c', 'd', 'e'], 2)

**Params**
* `array` **{Array}**
* `returns` **{Array}**: Flattened array
**Example**
```js

@@ -198,7 +229,11 @@ flatten(['a', ['b', ['c']], 'd', ['e']]);

**Params**
* `array` **{Array}**
* `fn` **{Function}**
* `thisArg` **{Object}**: Optionally pass a `thisArg` to be used as the context in which to call the function.
* `returns`: {Array}
* `returns` **{Array}**
**Example**
```js

@@ -220,4 +255,8 @@ forEach(['a', 'b', 'c'], function (ele) {

**Params**
* `value` **{Array}**: Value to test.
**Example**
```js

@@ -235,6 +274,10 @@ isArray(1);

**Params**
* `array` **{Array}**
* `n` **{Number}**: Number of items to return, starting with the last item.
* `returns`: {Array}
* `returns` **{Array}**
**Example**
```js

@@ -249,6 +292,10 @@ last(['a', 'b', 'c', 'd', 'e'], 2)

**Params**
* `array` **{Array}**
* `fn` **{Function}**
* `returns`: {Array}
* `returns` **{Array}**
**Example**
```js

@@ -270,2 +317,4 @@ map(['a', 'b', 'c'], function (ele) {

**Params**
* `array` **{Array}**: the array to slice.

@@ -275,2 +324,4 @@ * `start` **{Number}**: Optionally define the starting index.

**Example**
```js

@@ -287,5 +338,9 @@ var arr = ['a', 'b', 'd', 'e', 'f', 'g', 'h', 'i', 'j'];

**Params**
* `array` **{Array}**: The array to uniquify
* `returns` **{Array}**: With all union values.
**Example**
```js

@@ -300,5 +355,9 @@ union(['a', 'b', 'c', 'c']);

**Params**
* `array` **{Array}**: The array to uniquify
* `returns` **{Array}**: With all unique values.
**Example**
```js

@@ -311,2 +370,7 @@ unique(['a', 'b', 'c', 'c']);

Returns `true` if `value` exists in the given string, array
or object. See [any] for documentation.
**Params**
* `value` **{*}**

@@ -316,18 +380,14 @@ * `target` **{*}**

Returns `true` if `value` exists in the given string, array
or object. See [any] for documentation.
### [.contains](lib/collection/contains.js#L17)
Return true if `collection` contains `value`
**Params**
* `collection` **{Array|Object}**
* `string` **{*}**
* `returns`: {Boolean}
* `returns` **{Boolean}**
Return true if `collection` contains `value`
### [.tryReaddir](lib/fs/tryReaddir.js#L16)
* `dir` **{String}**: Starting directory
* `returns` **{Array}**: Array of files.
Try to read the given `directory`. Wraps `fs.readdirSync()` with

@@ -337,10 +397,17 @@ a try/catch, so it fails silently instead of throwing when the

**Params**
* `dir` **{String}**: Starting directory
* `returns` **{Array}**: Array of files.
### [.tryRequire](lib/fs/tryRequire.js#L15)
Try to require the given file, returning `null` if not successful
instead of throwing an error.
**Params**
* `fp` **{String}**: File path of the file to require
* `returns` **{*}**: Returns the module function/object, or `null` if not found.
Try to require the given file, returning `null` if not successful
instead of throwing an error.
### [.hasValues](lib/lang/hasValues.js#L34)

@@ -350,2 +417,4 @@

**Params**
* `object` **{Object}**: The object to check for `value`

@@ -355,2 +424,4 @@ * `value` **{*}**: the value to look for

**Example**
```js

@@ -380,2 +451,4 @@ utils.lang.hasValues('a');

**Params**
* `object` **{Object}**: The object to check for `value`

@@ -385,2 +458,4 @@ * `value` **{*}**: the value to look for

**Example**
```js

@@ -410,5 +485,9 @@ utils.lang.isEmpty('a');

**Params**
* `value` **{Object}**: The value to check.
* `returns`: {Boolean}
* `returns` **{Boolean}**
**Example**
```js

@@ -426,5 +505,9 @@ isObject(['a', 'b', 'c'])

**Params**
* `value` **{Object}**: The value to check.
* `returns`: {Boolean}
* `returns` **{Boolean}**
**Example**
```js

@@ -445,5 +528,9 @@ isPlainObject(Object.create({}));

**Params**
* `array` **{Array}**: Array of numbers to add up.
* `returns`: {Number}
* `returns` **{Number}**
**Example**
```js

@@ -456,16 +543,20 @@ sum([1, 2, 3, 4, 5])

Extend `object` with properties of other `objects`
**Params**
* `object` **{Object}**: The target object. Pass an empty object to shallow clone.
* `objects` **{Object}**
* `returns`: {Object}
* `returns` **{Object}**
Extend `object` with properties of other `objects`
### [.extend](lib/object/extend.js#L16)
Extend `o` with properties of other `objects`.
**Params**
* `o` **{Object}**: The target object. Pass an empty object to shallow clone.
* `objects` **{Object}**
* `returns`: {Object}
* `returns` **{Object}**
Extend `o` with properties of other `objects`.
### [.functions](lib/object/functions.js#L20)

@@ -475,5 +566,9 @@

**Params**
* `obj` **{Object}**
* `returns`: {Object}
* `returns` **{Object}**
**Example**
```js

@@ -488,6 +583,10 @@ functions({a: 'b', c: function() {}});

**Params**
* `key` **{String}**
* `obj` **{Object}**: Optionally pass an object to check.
* `returns`: {Boolean}
* `returns` **{Boolean}**
**Example**
```js

@@ -499,25 +598,61 @@ hasOwn(obj, key);

Return an array of keys for the given `obj`. Uses `Object.keys`
when available, otherwise falls back on `forOwn`.
**Params**
* `obj` **{Object}**
* `returns` **{Array}**: Array of keys.
Return an array of keys for the given `obj`. Uses `Object.keys`
when available, otherwise falls back on `forOwn`.
### [.merge](lib/object/merge.js#L23)
Recursively combine the properties of `o` with the
properties of other `objects`.
**Params**
* `o` **{Object}**: The target object. Pass an empty object to shallow clone.
* `objects` **{Object}**
* `returns`: {Object}
* `returns` **{Object}**
Recursively combine the properties of `o` with the
properties of other `objects`.
### [.methods](lib/object/methods.js#L15)
* `obj` **{Object}**
* `returns`: {Array}
Returns a list of all enumerable properties of `obj` that have function
values
**Params**
* `obj` **{Object}**
* `returns` **{Array}**
### [.reduce](lib/object/reduce.js#L32)
Reduces an object to a value that is the accumulated result of running each property in the object through a callback.
**Params**
* `obj` **{Object}**: The object to iterate over.
* `iterator` **{Function}**: Iterator function
* `initial` **{Object}**: Initial value.
* `thisArg` **{Object}**: The `this` binding of the iterator function.
* `returns` **{Object}**
**Example**
```js
var a = {a: 'foo', b: 'bar', c: 'baz'};
reduce(a, function (acc, value, key, obj) {
// `acc`- the initial value (or value from the previous callback call),
// `value`- the of the current property,
// `key`- the of the current property, and
// `obj` - original object
acc[key] = value.toUpperCase();
return acc;
}, {});
//=> {a: 'FOO', b: 'BAR', c: 'BAZ'};
```
### [.camelcase](lib/string/camelcase.js#L20)

@@ -527,5 +662,9 @@

**Params**
* `string` **{String}**: The string to camelcase.
* `returns`: {String}
* `returns` **{String}**
**Example**
```js

@@ -540,5 +679,9 @@ camelcase("foo bar baz");

**Params**
* `str` **{String}**: The string to reverse.
* `returns` **{String}**: Centered string.
**Example**
```js

@@ -552,5 +695,9 @@ centerAlign("abc");

**Params**
* `string` **{String}**: The string to chop.
* `returns`: {String}
* `returns` **{String}**
**Example**
```js

@@ -571,2 +718,4 @@ chop("_ABC_");

**Params**
* `string` **{String}**

@@ -576,2 +725,4 @@ * `substring` **{String}**

**Example**
```js

@@ -586,5 +737,9 @@ count("abcabcabc", "a");

**Params**
* `string` **{String}**
* `returns`: {String}
* `returns` **{String}**
**Example**
```js

@@ -599,5 +754,9 @@ dashcase("a b.c d_e");

**Params**
* `string` **{String}**
* `returns`: {String}
* `returns` **{String}**
**Example**
```js

@@ -612,2 +771,4 @@ dotcase("a-b-c d_e");

**Params**
* `str` **{String}**

@@ -618,2 +779,4 @@ * `length` **{Number}**: The desired length of the returned string.

**Example**
```js

@@ -628,5 +791,9 @@ ellipsis("<span>foo bar baz</span>", 7);

**Params**
* `string` **{String}**
* `returns`: {String}
* `returns` **{String}**
**Example**
```js

@@ -641,5 +808,9 @@ hyphenate("a b c");

**Params**
* `val` **{String}**
* `returns` **{Boolean}**: True if the value is a string.
**Example**
```js

@@ -657,5 +828,9 @@ isString('abc');

**Params**
* `string` **{String}**
* `returns`: {String}
* `returns` **{String}**
**Example**
```js

@@ -670,5 +845,9 @@ pascalcase("foo bar baz");

**Params**
* `string` **{String}**
* `returns`: {String}
* `returns` **{String}**
**Example**
```js

@@ -683,7 +862,11 @@ pathcase("a-b-c d_e");

**Params**
* `str` **{String}**
* `a` **{String|RegExp}**: Can be a string or regexp.
* `b` **{String}**
* `returns`: {String}
* `returns` **{String}**
**Example**
```js

@@ -698,5 +881,9 @@ replace("abcabc", /a/, "z");

**Params**
* `str` **{String}**: The string to reverse.
* `returns`: {String}
* `returns` **{String}**
**Example**
```js

@@ -711,5 +898,9 @@ reverse("abc");

**Params**
* `str` **{String}**: The string to reverse.
* `returns` **{String}**: Right-aligned string.
**Example**
```js

@@ -723,5 +914,9 @@ rightAlign(str);

**Params**
* `string` **{String}**
* `returns`: {String}
* `returns` **{String}**
**Example**
```js

@@ -736,5 +931,9 @@ sentencecase("foo bar baz.");

**Params**
* `string` **{String}**
* `returns`: {String}
* `returns` **{String}**
**Example**
```js

@@ -749,2 +948,4 @@ snakecase("a-b-c d_e");

**Params**
* `str` **{String}**

@@ -754,2 +955,4 @@ * `length` **{Number}**: The desired length of the returned string.

**Example**
```js

@@ -764,2 +967,4 @@ truncate("<span>foo bar baz</span>", 7);

**Params**
* `string` **{String}**: The string with words to wrap.

@@ -769,2 +974,4 @@ * `object` **{Options}**: Options to pass to [word-wrap]

**Example**
```js

@@ -856,6 +1063,6 @@ wordwrap("a b c d e f", {width: 5, newline: '<br> '});

-----------------------|-----------|-----------|-----------|-----------|
```
## Running tests
Install dev dependencies:

@@ -867,4 +1074,4 @@

## Contributing
## Contributing
> Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/utils/issues)

@@ -883,3 +1090,3 @@

- External modules will only be considered if they meet the same quality and coding standards as the rest of the library. At minimum this includes documentation, code comments, and unit tests. Benchmarks are also strongly preferred.
- External modules will only be considered if they meet the same quality and coding standards as the rest of the library. At minimum this includes documentation, code comments, and unit tests. Benchmarks are also strongly preferred.

@@ -894,2 +1101,3 @@ ### Updating the docs

### Running verb
Run [verb] to generate documentation:

@@ -901,4 +1109,2 @@

## About

@@ -908,3 +1114,3 @@

- I'm a node.js developer. I want fast, light, dependable utility functions for node.js projects.
- I'm a node.js developer. I want fast, light, dependable utility functions for node.js projects.
- Do you really need bloated, everything-but-the-kitchen-sink functions that are guaranteed to work with IE 4, **for your Yeoman generator or gulp plugin**!? Nonsense.

@@ -915,3 +1121,3 @@ - The benchmarks that accompany many of the functions in the library show that in some cases, the penalty for using such "kitchen-sink" code is a 2,000-5,000% reduction in speed. Sometimes greater.

- Fastest implementation of each method, without too much compromise. Covering uncommon cases is fine, but don't go overboard.
- Fastest implementation of each method, without too much compromise. Covering uncommon cases is fine, but don't go overboard.
- Clean well-documented, commented code.

@@ -922,29 +1128,30 @@ - [When it makes sense](#adding-utils), external libraries are used and exposed instead of writing new code.

## Related projects
> This project depends on these great libraries:
* [any](https://github.com/jonschlinkert/any): Returns `true` if a value exists in the given string, array or object.
* [arr-diff](https://github.com/jonschlinkert/arr-diff): Returns an array with only the unique values from the first array, by excluding all values from additional arrays using strict equality for comparisons.
* [arr-flatten](https://github.com/jonschlinkert/arr-flatten): Recursively flatten an array or arrays. This is the fastest implementation of array flatten.
* [arr-map](https://github.com/jonschlinkert/arr-map): Faster, node.js focused alternative to JavaScript's native array map.
* [arr-union](https://github.com/jonschlinkert/arr-union): Combines a list of arrays, returning a single array with unique values, using strict equality for comparisons.
* [array-each](https://github.com/jonschlinkert/array-each): Loop over each item in an array and call the given function on every element.
* [array-slice](https://github.com/jonschlinkert/array-slice): Array-slice method. Slices `array` from the `start` index up to, but not including, the `end` index.
* [array-unique](https://github.com/jonschlinkert/array-unique): Return an array free of duplicate values. Fastest ES5 implementation.
* [center-align](https://github.com/jonschlinkert/center-align): Center-align the text in a string.
* [export-dirs](https://github.com/jonschlinkert/export-dirs): Export directories and their files as node.js modules.
* [export-files](https://github.com/jonschlinkert/export-files): node.js utility for exporting a directory of files as modules.
* [for-in](https://github.com/jonschlinkert/for-in): Iterate over the own and inherited enumerable properties of an objecte, and return an object with properties that evaluate to true from the callback. Exit early by returning `false`. JavaScript/Node.js
* [for-own](https://github.com/jonschlinkert/for-own): Iterate over the own enumerable properties of an object, and return an object with properties that evaluate to true from the callback. Exit early by returning `false`. JavaScript/Node.js.
* [has-values](https://github.com/jonschlinkert/has-values): Returns true if any values exist, false if empty. Works for booleans, functions, numbers, strings, nulls, objects and arrays.
* [is-number](https://github.com/jonschlinkert/is-number): Returns true if the value is a number. comprehensive tests.
* [is-plain-object](https://github.com/jonschlinkert/is-plain-object): Returns true if an object was created by the `Object` constructor.
* [kind-of](https://github.com/jonschlinkert/kind-of): Get the native type of a value.
* [make-iterator](https://github.com/jonschlinkert/make-iterator): Convert an argument into a valid iterator. Based on the `.makeIterator()` implementation in mout https://github.com/mout/mout.
* [object.defaults](https://github.com/jonschlinkert/object.defaults): Like `extend` but only copies missing properties/values to the target object.
* [object.filter](https://github.com/jonschlinkert/object.filter): Create a new object filtered to have only properties for which the callback returns true.
* [object.omit](https://github.com/jonschlinkert/object.omit): Return a copy of an object without the given key, or array of keys.
* [object.pick](https://github.com/jonschlinkert/object.pick): Returns a filtered copy of an object with only the specified keys, like `pick` from lo-dash / underscore.
* [object.reduce](https://github.com/jonschlinkert/object.reduce): Reduces an object to a value that is the accumulated result of running each property in the object through a callback.
* [right-align](https://github.com/jonschlinkert/right-align): Right-align the text in a string.
* [word-wrap](https://github.com/jonschlinkert/word-wrap): Wrap words to a specified length.
* [any](https://github.com/jonschlinkert/any): Returns `true` if a value exists in the given string,… [more](https://github.com/jonschlinkert/any)
* [arr-diff](https://github.com/jonschlinkert/arr-diff): Returns an array with only the unique values from the… [more](https://github.com/jonschlinkert/arr-diff)
* [arr-flatten](https://github.com/jonschlinkert/arr-flatten): Recursively flatten an array or arrays. This is the fastest… [more](https://github.com/jonschlinkert/arr-flatten)
* [arr-map](https://github.com/jonschlinkert/arr-map): Faster, node.js focused alternative to JavaScript's native array map.
* [arr-union](https://github.com/jonschlinkert/arr-union): Combines a list of arrays, returning a single array with… [more](https://github.com/jonschlinkert/arr-union)
* [array-each](https://github.com/jonschlinkert/array-each): Loop over each item in an array and call the… [more](https://github.com/jonschlinkert/array-each)
* [array-slice](https://github.com/jonschlinkert/array-slice): Array-slice method. Slices `array` from the `start` index up to,… [more](https://github.com/jonschlinkert/array-slice)
* [array-unique](https://github.com/jonschlinkert/array-unique): Return an array free of duplicate values. Fastest ES5 implementation.
* [center-align](https://github.com/jonschlinkert/center-align): Center-align the text in a string.
* [export-dirs](https://github.com/jonschlinkert/export-dirs): Export directories and their files as node.js modules.
* [export-files](https://github.com/jonschlinkert/export-files): node.js utility for exporting a directory of files as modules.
* [for-in](https://github.com/jonschlinkert/for-in): Iterate over the own and inherited enumerable properties of an… [more](https://github.com/jonschlinkert/for-in)
* [for-own](https://github.com/jonschlinkert/for-own): Iterate over the own enumerable properties of an object, and… [more](https://github.com/jonschlinkert/for-own)
* [has-values](https://github.com/jonschlinkert/has-values): Returns true if any values exist, false if empty. Works… [more](https://github.com/jonschlinkert/has-values)
* [is-number](https://github.com/jonschlinkert/is-number): Returns true if the value is a number. comprehensive tests.
* [is-plain-object](https://github.com/jonschlinkert/is-plain-object): Returns true if an object was created by the `Object`… [more](https://github.com/jonschlinkert/is-plain-object)
* [kind-of](https://github.com/jonschlinkert/kind-of): Get the native type of a value.
* [make-iterator](https://github.com/jonschlinkert/make-iterator): Convert an argument into a valid iterator. Based on the… [more](https://github.com/jonschlinkert/make-iterator)
* [object.defaults](https://github.com/jonschlinkert/object.defaults): Like `extend` but only copies missing properties/values to the target… [more](https://github.com/jonschlinkert/object.defaults)
* [object.filter](https://github.com/jonschlinkert/object.filter): Create a new object filtered to have only properties for… [more](https://github.com/jonschlinkert/object.filter)
* [object.omit](https://github.com/jonschlinkert/object.omit): Return a copy of an object without the given key,… [more](https://github.com/jonschlinkert/object.omit)
* [object.pick](https://github.com/jonschlinkert/object.pick): Returns a filtered copy of an object with only the… [more](https://github.com/jonschlinkert/object.pick)
* [object.reduce](https://github.com/jonschlinkert/object.reduce): Reduces an object to a value that is the accumulated… [more](https://github.com/jonschlinkert/object.reduce)
* [right-align](https://github.com/jonschlinkert/right-align): Right-align the text in a string.
* [word-wrap](https://github.com/jonschlinkert/word-wrap): Wrap words to a specified length.

@@ -956,13 +1163,17 @@ ## Author

+ [github/jonschlinkert](https://github.com/jonschlinkert)
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
## License
Copyright (c) 2014-2015 Jon Schlinkert
Released under the MIT license
<!-- generated reference links -->
Copyright (c) 2015 Jon Schlinkert
Released under the MIT license.
***
_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on April 25, 2015._
<!-- reflinks generated by verb-reflinks plugin -->
[verb]: https://github.com/assemble/verb
[template]: https://github.com/jonschlinkert/template
[assemble]: http://assemble.io
<!-- deps:mocha jshint-stylish -->
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc