Skip to content

coderaiser/flop

Repository files navigation

Flop License NPM version Build Status

FLOP - Folder operations module.

Install

For use as application you could use global install.

npm i flop -g

If you run flop -h you will see:

flop - folder operations module.
options:
-h, --help - show this message
-r, --read - get directory content

Also you can use flop as a module if install with

npm i flop

API

create

Create new directory.

const flop = require('flop');

flop.create('./hello/world/from/flop', (error, data) => {
    console.log(error, data);
});

read

Read content of directory with permisions and sizes.

Parameters:

  • path
  • type (optional)
  • options (optional)

Posible type:

  • raw
  • size
  • size raw
const flop = require('flop');

await flop.read('.');
await flop.read('.', {
    sort: 'size',
});
await flop.read('.', 'raw');
await flop.read('.', 'size');
await flop.read('.', 'size raw');

copy

const flop = require('flop');

await flop.copy('from', 'to');

move

const flop = require('flop');

await flop.move('from', 'to');

remove

await flop.remove('path/to/remove');
await flop.remove('path/to/remove', ['folder1', 'folder2']);

License

MIT