massive update, probably broken
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-json / node_modules / concat-map / README.markdown
1 concat-map
2 ==========
3
4 Concatenative mapdashery.
5
6 [![browser support](http://ci.testling.com/substack/node-concat-map.png)](http://ci.testling.com/substack/node-concat-map)
7
8 [![build status](https://secure.travis-ci.org/substack/node-concat-map.png)](http://travis-ci.org/substack/node-concat-map)
9
10 example
11 =======
12
13 ``` js
14 var concatMap = require('concat-map');
15 var xs = [ 1, 2, 3, 4, 5, 6 ];
16 var ys = concatMap(xs, function (x) {
17     return x % 2 ? [ x - 0.1, x, x + 0.1 ] : [];
18 });
19 console.dir(ys);
20 ```
21
22 ***
23
24 ```
25 [ 0.9, 1, 1.1, 2.9, 3, 3.1, 4.9, 5, 5.1 ]
26 ```
27
28 methods
29 =======
30
31 ``` js
32 var concatMap = require('concat-map')
33 ```
34
35 concatMap(xs, fn)
36 -----------------
37
38 Return an array of concatenated elements by calling `fn(x, i)` for each element
39 `x` and each index `i` in the array `xs`.
40
41 When `fn(x, i)` returns an array, its result will be concatenated with the
42 result array. If `fn(x, i)` returns anything else, that value will be pushed
43 onto the end of the result array.
44
45 install
46 =======
47
48 With [npm](http://npmjs.org) do:
49
50 ```
51 npm install concat-map
52 ```
53
54 license
55 =======
56
57 MIT
58
59 notes
60 =====
61
62 This module was written while sitting high above the ground in a tree.