Blame view

node_modules/batch/Readme.md 731 Bytes
aaac7fed   liuqimichale   add
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
  
  # batch
  
    Simple async batch with concurrency control and progress reporting.
  
  ## Installation
  
  ```
  $ npm install batch
  ```
  
  ## API
  
  ```js
  var Batch = require('batch')
    , batch = new Batch;
  
  batch.concurrency(4);
  
  ids.forEach(function(id){
    batch.push(function(done){
      User.get(id, done);
    });
  });
  
  batch.on('progress', function(e){
  
  });
  
  batch.end(function(err, users){
  
  });
  ```
  
  ### Progress events
  
    Contain the "job" index, response value, duration information, and completion data.
  
  ```
  { index: 1,
    value: 'bar',
    pending: 2,
    total: 3,
    complete: 2,
    percent: 66,
    start: Thu Oct 04 2012 12:25:53 GMT-0700 (PDT),
    end: Thu Oct 04 2012 12:25:53 GMT-0700 (PDT),
    duration: 0 }
  ```
  
  ## License
  
  [MIT](LICENSE)