eden-file

#File

DESCRIPTION

General

Installation

npm install eden-file

Usage

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

Methods

• copy

• getBase

• getContent

• getData

• getExtension

• getMime

• getParent

• getName

• getPermissions

• getSize

• getReadStream

• getWriteStream

• getTime

• isFile

• setContent

• setData

• remove

---

copy

 this copy(__dirname + '/bar/foo.txt');

Copy folder to path Note: This has to be async

Parameters

1. __dirname + '/bar/foo.txt' - string

Returns

this

Example

Code

  var item = file(__dirname + '/foo/bar.txt');

    item.copy(__dirname + '/bar/foo.txt', function(error));
file().copy(error);

Outputs

null

---

getBase

 string getBase();

Returns the base name of the file

Parameters

Returns

string

Example

Code

  var item = file(__dirname + '/foo/bar.txt');

item.getBase();

Outputs

'bar'

---

getContent

 this getContent(content, String);

Returns file content

Parameters

1. content - function

2. string

Returns

this

Example

Code

  item.getContent(function(error, content));

file().getContent(content);

Outputs

'Mocha Test'

---

getData

 this getData(data);

Returns JSON data in file

Parameters

1. data - function (to get)

Returns

this

Example

Code

  var item = file(__dirname + '/foo/bar.txt');

    item.getData(function(error, data));
file().getData(data.foo);

Outputs

'bar'

---

getExtension

 string getExtension();

Returns the file extension

Parameters

Returns

string

Example

Code

  var item = file(__dirname + '/foo/bar.txt');

item.getExtension();

Outputs

'txt'

---

getMime

 string getMime();

Returns file mime type

Parameters

Returns

string

Example

Code

  var item = file(__dirname + '/foo/bar.txt');

item.getMime();

Outputs

'text/plain'

---

getParent

 string getParent();

Returns the folder path

Parameters

Returns

string

Example

Code

  var sep = require('path').sep;
  var item = file(__dirname + '/foo/bar.txt');

item.getParent();

Outputs

__dirname + sep + 'foo'

---

getName

 string getName();

Returns just the file name

Parameters

Returns

string

Example

Code

  var item = file(__dirname + '/foo/bar.txt');

item.getName();

Outputs

'bar.txt'

---

getPermissions

 number getPermissions();

Returns numeric permissions

Parameters

Returns

number

Example

Code

  var item = file(__dirname + '/foo/bar.txt');

item.getPermissions() >= 644;

Outputs

true

---

getSize

 number getSize();

Returns the file size in bytes

Parameters

Returns

number

Example

Code

  var item = file(__dirname + '/foo/bar.txt');

item.getSize();

Outputs

10

---

getReadStream

 resource getReadStream();

Returns the read stream if you want to do more advance things

Parameters

Returns

resource

Example

Code

file().getReadStream();

Outputs

RESULTS

---

getWriteStream

 resource getWriteStream();

Returns the write stream if you want to do more advance things

Parameters

Returns

resource

Example

Code

file().getWriteStream();

Outputs

RESULTS

---

getTime

 number getTime();

Returns the last updated time in unix format

Parameters

Returns

number

Example

Code

  var item = file(__dirname + '/foo/bar.txt');

item.getTime() > 0;

Outputs

true

---

isFile

 bool isFile();

Returns true if the file is a real file in the system

Parameters

Returns

bool

Example

Code

  var item = file(__dirname + '/foo/bar.txt');

item.isFile();

Outputs

true

---

setContent

 this setContent('Mocha Test', error|true);

Sets the content of the file

Parameters

1. 'Mocha Test' - string

2. error - function|true

Returns

this

Example

Code

  item.setContent('Mocha Test', function(error));

file().setContent(error);

Outputs

null

---

setData

 this setData({foo: 'bar'}, error|true);

Sets JSON data into a file

Parameters

1. {foo: 'bar'} - mixed

2. error - function|true

Returns

this

Example

Code

  var item = file(__dirname + '/foo/bar.txt');

    item.setData({foo: 'bar'}, function(error));
file().setData(error);

Outputs

null

---

remove

 this remove();

Removes the file

Parameters

Returns

this

Example

Code

  var item = file(__dirname + '/foo/bar.txt');

    item.remove(function(error));
file().remove(error);

    folder(__dirname + '/foo').remove(function(error));
file().remove(error);

    folder(__dirname + '/bar').remove(function(error));
file().remove(error);

Outputs

null

null

null