Socket
Socket
Sign inDemoInstall

cmd.js

Package Overview
Dependencies
0
Maintainers
1
Versions
16
Alerts
File Explorer

Advanced tools

npm Scripts
License

Install Socket

Detect and block malicious and high-risk dependencies

Install

Comparing version 0.1.6 to 0.1.7

readme/call.md
readme/count.md
readme/default.md
readme/get.md
readme/has.md
readme/not.md
readme/reject.md
readme/reverse.md
readme/tap.md
src/lib/call.js
src/lib/count.js
src/lib/default.js
src/lib/get.js
src/lib/has.js
src/lib/not.js
src/lib/reject.js
src/lib/reverse.js
test/call.spec.js
test/count.spec.js
test/default.spec.js
test/get.spec.js
test/has.spec.js
test/not.spec.js
test/reject.spec.js
test/reverse.spec.js

11

gulpfile.js

@@ -16,16 +16,7 @@ 'use strict';

var readme = 'readme/*.md';
gulp.task('readme', function() {
return gulp.src(readme)
.pipe(concat('README.md'))
.pipe(gulp.dest('.'));
});
gulp.task('watch', function () {
gulp.watch(lib, ['lib']);
gulp.watch(readme, ['readme']);
});
gulp.task('default', ['lib', 'readme']);
gulp.task('default', ['lib']);
gulp.task('start', ['default', 'watch']);

2

package.json
{
"name": "cmd.js",
"version": "0.1.6",
"version": "0.1.7",
"description": "A chainable utility toolkit for JavaScript.",

@@ -5,0 +5,0 @@ "main": "index.js",

544

README.md

@@ -51,2 +51,85 @@ # cmd.js

## Index of Commands
### A
[add](readme/add.md)
[alert](readme/alert.md)
### C
[call](readme/call.md)
[case](readme/case.md)
[clone](readme/clone.md)
[compare](readme/compare.md)
[count](readme/count.md)
### D
[default](readme/default.md)
[divide](readme/divide.md)
### E
[equals](readme/equals.md)
[exists](readme/exists.md)
[extend](readme/extend.md)
### F
[filter](readme/filter.md)
[format](readme/format.md)
### G
[get](readme/get.md)
### H
[has](readme/has.md)
### J
[join](readme/join.md)
### L
[log](readme/log.md)
[logger](readme/logger.md)
### M
[match](readme/match.md)
[max](readme/max.md)
[min](readme/min.md)
[multiply](readme/multiply.md)
### N
[not](readme/not.md)
### O
[obj](readme/obj.md)
### P
[product](readme/product.md)
[push](readme/push.md)
### R
[reject](readme/reject.md)
[reverse](readme/reverse.md)
### S
[sort](readme/sort.md)
[subtract](readme/subtract.md)
[sum](readme/sum.md)
### T
[tap](readme/tap.md)
## Chaining Example

@@ -93,7 +176,5 @@

var pluck = cmd.pluck;
var sortAndPrint = cmd.sort(cmd.get('age')).
and.logger(cmd.get('name'), cmd.get('id'));
var sortAndPrint = cmd.sort(pluck('age')).
and.logger(pluck('name'), pluck('id'));
sortAndPrint(users);

@@ -110,12 +191,2 @@

### Developer Notes
Development dependencies can be installed with `npm install` or `make install` for convenience.
Testing is accomplished with [mocha](http://mochajs.org/), and can be run with `npm test` or `make test`. There's also a handy `make test-watch` to see live test results during development.
This project is built with [gulp](http://gulpjs.com/). Make all changes/additions in `src/lib/*.js` while running `make build-watch` from the command line.
# API Reference
## Types of Commands

@@ -131,3 +202,3 @@

These commands operate on each value passed in and thus do not have access to each value during processing. This also means that every "each" command returns an array at all times. Both arguments and values are subject to argument merging as described below.
These commands operate on each value passed in and thus do not have access to other values during processing. This also means that every "each" command returns an array at all times. Both arguments and values are subject to argument merging as described below.

@@ -221,443 +292,8 @@ Some commands do not accept arguments, and only the values need to be provided.

## All Modules
## Developer Notes
### cmd.add
Development dependencies can be installed with `npm install` or `make install` for convenience.
| name | return value | description |
|-------------|---------------|---------------|
| `add` | `[100, ...]` | Returns the sum of all arguments added to each given value. |
Testing is accomplished with [mocha](http://mochajs.org/), and can be run with `npm test` or `make test`. There's also a handy `make test-watch` to see live test results during development.
The following example adds 10 to each value:
```js
cmd.add(10)(1, 2, 3, 4, 5);
// [11, 12, 13, 14, 15]
```
### cmd.alert
| name | return value | description |
|----------|---------------------|---------------|
| `alert` | `[undefined, ...]` | Causes a browser alert for each value passed in. Does nothing in a Node.js environment. |
The following example displays two alerts in sequence:
```js
cmd.alert('Hello World!', 'Will Smith here.');
// two alerts displayed (only in browser)
```
### cmd.case.*
| name | return value | description |
|---------------|--------------------------------|---------------|
| `case.lower` | `['change string case', ...]` | Convert strings to lower case. |
| `case.title` | `['Change String Case', ...]` | Convert strings to title case. |
| `case.upper` | `['CHANGE STRING CASE', ...]` | Convert strings to upper case. |
The following example converts strings to lowercase:
```js
cmd.case.lower('Hello World!', 'Will Smith here.');
// ["hello world!", "will smith here."]
```
### cmd.clone
| name | return value | description |
|----------|-----------------|---------------|
| `clone` | `[mixed, ...]` | Clone any JavaScript variable not containing a circular reference. |
The following example clones an object:
```js
var answer = {data: 42};
var cloned = cmd.clone.raw(answer); // raw returns non-wrapped first response
[cloned === answer, cloned.data === answer.data];
// [false, true]
```
### cmd.compare
| name | return value | description |
|------------|-----------------|---------------|
| `compare` | `-1 or 0 or 1` | Compare is a unique command in that it only accepts 2 values. Any further values will be ignored. It is used internally for `cmd.sort` but available for custom sorting as well. |
The following examples compare two values. Compare defines a sort order for any two JavaScript types:
```js
cmd.compare(8, 5);
// 3
cmd.compare(1000, 'a');
// -1
cmd.compare('boo', 'apple');
// 1
cmd.compare('hello', false);
// 1
```
### cmd.divide
| name | return value | description |
|-------------|---------------|---------------|
| `divide` | `[100, ...]` | Returns the product of all arguments divided by each given value. |
The following example divides each value by 10:
```js
cmd.divide(10)(1, 2, 3, 4, 5);
// [0.1, 0.2, 0.3, 0.4, 0.5]
```
### cmd.equals
| name | return value | description |
|------------|-------------------------|---------------|
| `equals` | `[true or false, ...]` | Checks if each value passed in equals any of the given arguments. |
The following example checks for values that equal 50 or 30:
```js
cmd.equals(30, 50)(100, 20, 50, 30);
// [false, false, true, true]
```
### cmd.exists
| name | return value | description |
|------------|-------------------------|---------------|
| `exists` | `[true or false, ...]` | Checks if each value passed in exists (not null or undefined). |
The following example checks the existence of the values. Only null and undefined count as not existing:
```js
cmd.exists(null, undefined, false, '', 0, true);
// [false, false, true, true, true, true]
```
### cmd.extend
| name | return value | description |
|------------|-----------------|---------------|
| `extend` | `[{...}, ...]` | Extends each value with each argument, in order. |
The following example adds the color red to each value passed in:
```js
cmd.extend({color: 'red'})({item: 'wrench'}, {item: 'apple'});
// [{item: 'wrench', color: 'red'}, {item: 'apple', color: 'red'}]
```
### cmd.filter
| name | return value | description |
|------------|-----------------|---------------|
| `filter` | `[mixed, ...]` | Filters out values based on arguments. |
The following example filters the values to only even numbers greater than 5:
```js
cmd.filter(function (x) {
return x % 2 === 0;
}, function (x) {
return x > 5;
})(1, 2, 3, 4, 5, 6, 7, 8, 9, 10);
// [6, 8, 10]
```
### cmd.format
| name | return value | description |
|------------|------------------------------|---------------|
| `format` | `['formatted string', ...]` | Formats string arguments using positional `{}` targets. |
The following example formats two strings using positional targets:
```js
cmd.format('I love {}pples, {}lueberries, and {}ake', '{} + {} = {}')('a', 'b', 'c');
// ["I love apples, blueberries, and cake", "a + b = c"]
```
### cmd.join
| name | return value | description |
|----------|---------------------------|---------------|
| `join` | `['joined string', ...]` | Joins values provided with arguments as glue. |
The following example joins the values using the glue provided in initial arguments:
```js
cmd.join('-', '+')('a', 'b', 'c');
// ["a-b-c", "a+b+c"]
```
### cmd.log
| name | return value | description |
|---------|-----------------|---------------|
| `log` | `[mixed, ...]` | Logs values and passes them through unchanged. |
The following example logs each value to the console and returns the values:
```js
cmd.log(1, 2, 3);
// 1
// 2
// 3
// [1, 2, 3]
```
### cmd.logger
| name | return value | description |
|------------|-----------------|---------------|
| `logger` | `[mixed, ...]` | Logs values once per each argument and passes them through unchanged. |
The following example logs each value wrapped in a custom log format to the console and returns the values. If a string is passed it will use `cmd.format` to format the logs:
```js
var withDate = function (x) {
return 'Log at ' + (new Date()) + ': ' + x;
};
cmd.logger(withDate, 'and the number is: {}')(1, 2, 3);
// Log at Sat Jan 31 2015 23:05:59 GMT-0800 (PST): 1 and the number is: 1
// Log at Sat Jan 31 2015 23:05:59 GMT-0800 (PST): 2 and the number is: 2
// Log at Sat Jan 31 2015 23:05:59 GMT-0800 (PST): 3 and the number is: 3
// [1, 2, 3]
```
### cmd.match
| name | return value | description |
|------------|-----------------|---------------|
| `match` | `[mixed, ...]` | Matches each item based on a condition and replaces the item with the value provided to `then`. |
The following example uses `cmd.match` to choose an appropriate sentence:
```js
var msgMatch = cmd.match(function (it, then) {
it > 5 && then('You have lots of messages');
it === 5 && then('You have five messages');
it > 1 && then('You have a few messages');
it === 1 && then('You have a message');
it === 0 && then('You have no messages');
then('Unknown');
});
msgMatch(0, 1, 2, 3, 4, 5, 6, 'x');
// ["You have no messages",
// "You have a message",
// "You have a few messages",
// "You have a few messages",
// "You have a few messages",
// "You have five messages",
// "You have lots of messages",
// "Unknown"]
```
### cmd.max
| name | return value | description |
|---------|---------------|---------------|
| `max` | `100` | Returns the maximum of all given values. |
The following example returns the maximum value:
```js
cmd.max(1, 2, 3, 4, 5);
// 5
```
### cmd.min
| name | return value | description |
|---------|---------------|---------------|
| `min` | `100` | Returns the minimum of all given values. |
The following example returns the minimum value:
```js
cmd.min(1, 2, 3, 4, 5);
// 1
```
### cmd.multiply
| name | return value | description |
|-------------|---------------|---------------|
| `multiply` | `[100, ...]` | Returns the product of all arguments multiplied by each given value. |
The following example multiplies each value by 10:
```js
cmd.multiply(10)(1, 2, 3, 4, 5);
// [10, 20, 30, 40, 50]
```
### cmd.obj
| name | return value | description |
|----------|------------------|---------------|
| `obj` | `[{ ... }, ...]` | Zips up an object using arguments as keys and values as values. |
The following example builds an object with keys and repeated values. Note the `[[wrapped array]]` syntax to avoid spreading the array as arguments:
```js
cmd.obj('name', 'age', 'city', 'interests')(
'Nate', 25, 'Los Angeles, CA', [['tech', 'javascript', 'node.js', 'space']]
);
// [{
// "name": "Nate",
// "age": 25,
// "city": "Los Angeles, CA",
// "interests": ["tech", "javascript", "node.js", "space"]
// }]
```
### cmd.pluck
| name | return value | description |
|------------|-----------------|---------------|
| `pluck` | `[mixed, ...]` | Surfaces data within a structure of objects or arrays, using arguments as keys. |
The following example plucks object properties:
```js
var people = [{
name: 'Adam',
pet: {
type: 'bird',
name: 'Sherlock'
}
}, {
name: 'Shannon',
pet: {
type: 'snake',
name: 'Rosa'
}
}, {
name: 'Upgrayyed',
pet: {
type: 'dog',
name: 'Maxximus'
}
}];
cmd.pluck('pet', 'name')(people);
// ["Sherlock", "Rosa", "Maxximus"]
```
### cmd.product
| name | return value | description |
|-------------|---------------|---------------|
| `product` | `100` | Returns the product of all given values. |
The following example returns the product 1 * 2 * 3 * 4 * 5:
```js
cmd.product(1, 2, 3, 4, 5);
// 120
```
### cmd.push.to
| name | return value | description |
|------------|-----------------|---------------|
| `push.to` | `[mixed, ...]` | Pushes provided values to each argument array. The use of `.to` avoids having to `[[double wrap]]` array arguments. |
The following example pushes to an array:
```js
var people = [];
var add = cmd.push.to(people);
add({
name: 'Adam'
});
add({
name: 'Blake'
});
console.log(people);
// [{"name":"Adam"}, {"name":"Blake"}]
```
Push returns the value(s) passed in, so it can be used perfectly while chaining commands:
```js
add.and.log({name: 'Charlie'});
// Object {name: "Charlie"}
people.length;
// 3
```
### cmd.sort
| name | return value | description |
|---------------|-----------------|---------------|
| `sort` | `[mixed, ...]` | Sorts the array in custom order. |
| `sort.asc` | `[mixed, ...]` | Sorts the array in ascending order. |
| `sort.desc` | `[mixed, ...]` | Sorts the array in descending order. |
The following example sorts the values with various sort orders and parameters:
```js
cmd.sort.asc('c', 'a', 'b', 3, 1, 2);
// [1, 2, 3, "a", "b", "c"]
cmd.sort.desc('c', 'a', 'b', 3, 1, 2);
// ["c", "b", "a", 3, 2, 1]
// Sort by type, leaving order preserved within a type
cmd.sort(function (x) {
return typeof x;
})('c', 'a', 'b', 3, 1, 2);
// [3, 1, 2, "c", "a", "b"]
// Sort objects by a key
cmd.sort(function (x) {
return x.price;
})(
{name: 'TV', price: 899.00},
{name: 'Car', price: 16999.00},
{name: 'Spoon', price: 1.29}
);
// [
// {name: "Spoon", price: 1.29},
// {name: "TV", price: 899},
// {name: "Car", price: 16999}
// ]
```
### cmd.subtract
| name | return value | description |
|-------------|---------------|---------------|
| `subtract` | `[100, ...]` | Returns the sum of all arguments subtracted from each given value. |
The following example subtracts 10 from each value:
```js
cmd.subtract(10)(1, 2, 3, 4, 5);
// [-9, -8, -7, -6, -5]
```
### cmd.sum
| name | return value | description |
|-------------|---------------|---------------|
| `sum` | `100` | Returns the sum of all given values. |
The following example returns the sum 1 + 2 + 3 + 4 + 5:
```js
cmd.sum(1, 2, 3, 4, 5);
// 15
```
This project is built with [gulp](http://gulpjs.com/). Make all changes/additions in `src/lib/*.js` while running `make build-watch` from the command line.

10

src/cmd.js

@@ -26,11 +26,15 @@ /**

'add', 'alert',
'case', 'clone', 'compare',
'divide',
'call', 'case', 'clone', 'compare', 'count',
'default', 'divide',
'equals', 'exists', 'extend',
'filter', 'format',
'get',
'has',
'join',
'log', 'logger',
'match', 'max', 'min', 'multiply',
'not',
'obj',
'pluck', 'product', 'push',
'product', 'push',
'reject', 'reverse',
'sort', 'subtract', 'sum',

@@ -37,0 +41,0 @@ 'tap'

2

test/case.spec.js

@@ -5,3 +5,3 @@ var cmd = require('../src/cmd');

/**
* Load the title plugin
* Load the case plugin
*/

@@ -8,0 +8,0 @@ cmd.use('case');

2

test/clone.spec.js

@@ -5,3 +5,3 @@ var cmd = require('../src/cmd');

/**
* Load the title plugin
* Load the clone plugin
*/

@@ -8,0 +8,0 @@ cmd.use('clone');

readme/_intro.md
readme/pluck.md
src/lib/pluck.js
test/pluck.spec.js
index.html

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

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

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc