fobject

A simple promise-based wrapper for file operations that treats files as objects.

File = require 'fobject'
configFile = new File('config.json')
configFile.read().done((data) ->
    console.log "contents of #{configFile.path}: #{data}"
)

why?

The default fs module has a really ugly interface (including sync and async copies of almost every function) and doesn't make it easy to work with files that may or may not actually be written to the file-system. fobject abstracts out interaction with the file system so if you want to implement caching, or work with files without writing them to the disk, or whatever else you want: you can do so easily.

docs

new File(path)

Parameters:

Name	Type	Argument	Default	Description
`path`	String			The path to the file. This will be resolved to an absolute path, so even if you change your cwd you can still access the same file.
`options.base`	String	<optional>	./	Used for relative pathing. This will not be resolved to an absolute path. Typically where a glob starts.

Source:

index.js , lineno 13

append(data) → {Promise}

Append data to the file

Parameters:

Name	Type	Argument	Default	Description
`data`	String \| Buffer
`options.encoding`	String \| null	<optional>	'utf8'	ignored if data is a buffer
`options.mode`	Number	<optional>	438	default is 0666 in Octal
`options.flag`	String	<optional>	'w'

Source:

index.js , lineno 83

Returns:

Type: Promise

dirname() → {String}

Get the dirname of the file

Source:

index.js , lineno 159

Returns:

Type: String

extname() → {String}

Get the extension of a file

Source:

index.js , lineno 147

Returns:

Type: String

read() → {Promise}

Read from the file

Parameters:

Name	Type	Argument	Default	Description
`options.encoding`	String \| null	<optional>	null
`options.flag`	String	<optional>	'r'

Source:

index.js , lineno 46

Returns:

Type: Promise

rename(newPath) → {Promise}

Rename the file

Parameters:

Name	Type	Description
`newPath`	String	The new path for the file. Will be resolved relative to File.base.

Source:

index.js , lineno 103

Returns:

Type: Promise

stat() → {Promise}

Return a Stat object for the file

Source:

index.js , lineno 135

Returns:

Type: Promise

unlink() → {Promise}

Delete the file

Source:

index.js , lineno 123

Returns:

Type: Promise

write(data) → {Promise}

Write data to the file

Parameters:

Name	Type	Argument	Default	Description
`data`	String \| Buffer
`options.encoding`	String \| null	<optional>	'utf8'	ignored if data is a buffer
`options.mode`	Number	<optional>	438	default is 0666 in Octal
`options.flag`	String	<optional>	'w'

Source:

index.js , lineno 63

Returns:

Type: Promise

generated with docme

Use this within your firewall

Combine open-source packages with your private code and publish to a private registry behind the firewall. npm ♥ enterprise developers

how? learn more

slang published 2016-05-04T05:02:35.255Z
0.0.4 is the latest of 5 releases
github.com/slang800/fobject
GPL-3.0

Collaborators list

Stats

6303 downloads in the last day
35310 downloads in the last week
154286 downloads in the last month
Have an issue? File it. on GitHub
on GitHub

fobject

fobject

why?

docs

new File(path)

Parameters:

append(data) → {Promise}

Parameters:

Returns:

dirname() → {String}

Returns:

extname() → {String}

Returns:

read() → {Promise}

Parameters:

Returns:

rename(newPath) → {Promise}

Parameters:

Returns:

stat() → {Promise}

Returns:

unlink() → {Promise}

Returns:

write(data) → {Promise}

Parameters:

Returns:

Use this within your firewall

Collaborators list

Stats

Try it out

Keywords

Dependencies (3)

Dependents (5)