eden-folder

#Folder

DESCRIPTION

General

Installation

npm install eden-folder

Usage

var folder = require('eden-folder');

Methods

• copy

• getFiles

• getFolders

• getName

• getParent

• getPermissions

• getTime

• isFolder

• mkdir

• remove

• truncate

copy

 this copy(String);

Copy folder to path

Parameters

• string

Returns

this

Example

Code

folder().copy();

Outputs

RESULTS

getFiles

 string getFiles();

Returns the files

Parameters

Returns

string

Example

Code

folder().getFiles();

Outputs

RESULTS

getFolders

 string getFolders();

Returns the folders in the path

Parameters

Returns

string

Example

Code

folder().getFolders();

Outputs

RESULTS

getName

 string getName();

Returns just the file name

Parameters

Returns

string

Example

Code

folder().getName();

Outputs

RESULTS

getParent

 string getParent();

Returns the folder path

Parameters

Returns

string

Example

Code

folder().getParent();

Outputs

RESULTS

getPermissions

 number getPermissions();

Returns numeric permissions

Parameters

Returns

number

Example

Code

folder().getPermissions();

Outputs

RESULTS

getTime

 number getTime();

Returns the last updated time in unix format

Parameters

Returns

number

Example

Code

folder().getTime();

Outputs

RESULTS

isFolder

 bool isFolder();

Returns true if the path is a real folder in the system

Parameters

Returns

bool

Example

Code

folder().isFolder();

Outputs

RESULTS

mkdir

 this mkdir(Callback);

Create folder with the specified path

Parameters

• callback

Returns

this

Example

Code

folder().mkdir();

Outputs

RESULTS

remove

 this remove();

Removes the folder

Parameters

Returns

this

Example

Code

folder().remove();

Outputs

RESULTS

truncate

 this truncate();

Empties the contents in the given folder

Parameters

Returns

this

Example

Code

folder().truncate();

Outputs

RESULTS