-
Notifications
You must be signed in to change notification settings - Fork 52
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added instructions regarding running the examples
- Loading branch information
Showing
2 changed files
with
62 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# readdirp examples | ||
|
||
## How to run the examples | ||
|
||
Assuming you installed readdirp (`npm install readdirp`), you can do the following: | ||
|
||
1. `npm explore readdirp` | ||
2. `cd examples` | ||
3. `npm install` | ||
|
||
At that point you can run the examples with node, i.e., `node grep`. | ||
|
||
## stream api | ||
|
||
[stream-api.js](https://github.com/thlorenz/readdirp/blob/master/examples/stream-api.js) | ||
|
||
Demonstrates error and data handling by listening to events emitted from the readdirp stream. | ||
|
||
## stream api pipe | ||
|
||
[stream-api-pipe.js](https://github.com/thlorenz/readdirp/blob/master/examples/stream-api-pipe.js) | ||
|
||
Demonstrates error handling by listening to events emitted from the readdirp stream and how to pipe the data stream into | ||
another destination stream. | ||
|
||
## grep | ||
|
||
[grep.js](https://github.com/thlorenz/readdirp/blob/master/examples/grep.js) | ||
|
||
Very naive implementation of grep, for demonstration purposes only. | ||
|
||
## using callback api | ||
|
||
[callback-api.js](https://github.com/thlorenz/readdirp/blob/master/examples/callback-api.js) | ||
|
||
Shows how to pass callbacks in order to handle errors and/or data. | ||
|