remove

Type:Function

Status:stable

Since:1.0.0

Platform:node

@blackbyte.sugar.node.fs

Removes a file or directory. The directory can have contents. If the path does not exist, silently does nothing. Like rm -rf (async)

Params

path*-String
The file/directory path to delete

Return

-Promise
A promise that will be resolved when the remove is completed

Example

import { remove } from '@blackbyte/sugar/fs';
await remove('my/cool/file.json').then(() => {
   // do something on complete...
});

Todo

testsnormal

Author

Olivier Bosselolivier.bossel@gmail.com https://blackbyte.space

See

https://github.com/jprichardson/node-fs-extra