Bug:Fix file validation issue
[vnfsdk/refrepo.git] / vnfmarket / src / main / webapp / vnfmarket / node_modules / readdirp / examples / Readme.md
1 # readdirp examples
2
3 ## How to run the examples
4
5 Assuming you installed readdirp (`npm install readdirp`), you can do the following:
6
7 1. `npm explore readdirp`
8 2. `cd examples`
9 3. `npm install`
10
11 At that point you can run the examples with node, i.e., `node grep`.
12
13 ## stream api
14
15 [stream-api.js](https://github.com/thlorenz/readdirp/blob/master/examples/stream-api.js)
16
17 Demonstrates error and data handling by listening to events emitted from the readdirp stream.
18
19 ## stream api pipe
20
21 [stream-api-pipe.js](https://github.com/thlorenz/readdirp/blob/master/examples/stream-api-pipe.js)
22
23 Demonstrates error handling by listening to events emitted from the readdirp stream and how to pipe the data stream into
24 another destination stream.
25
26 ## grep
27
28 [grep.js](https://github.com/thlorenz/readdirp/blob/master/examples/grep.js)
29
30 Very naive implementation of grep, for demonstration purposes only.
31
32 ## using callback api
33
34 [callback-api.js](https://github.com/thlorenz/readdirp/blob/master/examples/callback-api.js)
35
36 Shows how to pass callbacks in order to handle errors and/or data.
37