archive-gh-me/node-fs-extra
1
0
Fork 0
mirror of https://github.com/jprichardson/node-fs-extra.git synced 2026-01-25 16:42:57 +00:00
Code Issues Projects Releases Wiki Activity

update readme to reflect filter for copy() and options for {read,write}Json.

Browse Source
This commit is contained in:
JP Richardson 2013-10-14 08:59:56 -05:00
parent 299dd2dd27
commit ee91dde91c
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -63,7 +63,7 @@ Methods
**NOTE:** You can still use the native Node.js methods. They are copied over to `fs-extra`.
### copy(src, dest, callback)
### copy(src, dest, [filter], callback)
Copy a file or directory. The directory can have contents. Like `cp -r`. There isn't a synchronous version implemented yet.
@ -185,9 +185,9 @@ fs.outputJson(file, {name: 'JP'}, function(err) {
### readJson(file, callback)
### readJson(file, [options], callback)
Reads a JSON file and then parses it into an object.
Reads a JSON file and then parses it into an object. `options` are the same that you'd pass to `fs.readFile`.
Alias: `readJSON()`
@ -230,9 +230,9 @@ fs.removeSync('/home/jprichardson'); //I just deleted my entire HOME directory.
### writeJson(file, object, callback)
### writeJson(file, object, [options], callback)
Writes an object to a JSON file.
Writes an object to a JSON file. `options` are the same that you'd pass to `fs.readFile`.
Alias: `writeJSON()`