moveFile added to README

This commit is contained in:
Kyle Corbitt 2016-01-27 16:56:04 +00:00
parent 0fd5e85955
commit 4f54f85bba

View File

@ -192,6 +192,10 @@ Write the `contents` to `filepath`. `encoding` can be one of `utf8` (default), `
The promise resolves with a boolean.
### `promise moveFile(filepath, destPath)`
Moves the file located at `filepath` to `destPath`. This is more performant than reading and then re-writing the file data because the move is done natively and the data doesn't have to be copied or cross the bridge.
### `promise unlink(filepath)`
Unlinks the item at `filepath`. If the item does not exist, an error will be thrown.