fs-js

A native module for effectively working with files built on top of Node's famous fs module.

  • fs-js

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
fs-js
611.0.66 years ago6 years agoMinified + gzip package size for fs-js in KB

Readme

fs
A native module for effectively working with files built on top of Node's famous fs module.

Installation

With npm do ```bash $ npm install fs-js ```

Usage

```js var fs = require('fs-js'); ```

Open file

```js fs.open('myfile', 'wx', (err, fd) => { if (err) {
if (err.code === 'EEXIST') {
console.error('myfile already exists');
return;
}
throw err;
} writeMyData(fd); }); ```

Read file

```js fs.open('myfile', 'r', (err, fd) => { if (err) {
if (err.code === 'ENOENT') {
console.error('myfile does not exist');
return;
}
throw err;
} readMyData(fd); }); ```

Write file

```js fs.open('myfile', 'wx', (err, fd) => { if (err) {
if (err.code === 'EEXIST') {
console.error('myfile already exists');
return;
}
throw err;
} writeMyData(fd); }); ```

Delete file

```js fs.unlink('/tmp/hello', (err) => { if (err) throw err; console.log('successfully deleted /tmp/hello'); }); ```

Append file

```js fs.appendFile('message.txt', 'data to append', (err) => { if (err) throw err; console.log('The "data to append" was appended to file!'); }); ```

Rename file

```js fs.rename('/tmp/hello', '/tmp/world', (err) => { if (err) throw err; console.log('renamed complete'); }); ```

Documentation

Publicly accessible documentation is located here.

License

(MIT) Copyright (c) 2017 Nejc Trnjanin <zlatinejc@gmail.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.