JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
test
.eslintrc
.gitignore
.npmignore
.travis.yml
ChangeLog
LICENSE
README.md
package.json

README.md

Flop License NPM version Dependency Status 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)
  • callback

Posible type:

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

flop.read('.', (error, data) => {
    console.log(error, data);
});

flop.read('.', {sort: 'size'}, (error, data) => {
    console.log(error, data);
});

flop.read('.', 'raw', (error, data) => {
    console.log(error, data);
});


flop.read('.', 'time', (error, data) => {
    console.log(error, data);
});

flop.read('.', 'size', (error, data) => {
    console.log(error, data);
});

flop.read('.', 'size raw', (error, data) => {
    console.log(error, data);
});

copy

const flop = require('flop');

flop.copy('from', 'to', (error) => {
    console.log(error);
});

move

const flop = require('flop');

flop.move('from', 'to', (error) => {
    console.log(error);
});

remove

flop.remove('path/to/remove', (error) => {
    console.log(error);
});

flop.remove('path/to/remove', ['folder1', 'folder2'], (error) => {
    console.log(error);
});

License

MIT