Blame view

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