any-fs

Any-fs

Abstract away any filesystem (NodeJS) instance to a smarter interface

Purpose

Any-fs was designed to wrap filesystem interfaces like the following:

• Node's fs
• WebDAV-fs
• Dropbox-fs (v0.0.5 and up)

Into a common interface that provides a more intuitive syntax. Any-fs is designed to blindly take any of these systems and return a common API.

Usage

Node's fs

Usage with the built-in fs interface is the simplest use-case:

const fs = require("fs");
const anyFs = require("any-fs");

const afs = anyFs(fs);

afs
    .readDirectory("/")
    .then(function(contents) {
        console.log(contents.pop());
        // returns something like:
        // {
        //    name: "filename.txt,
        //    isFile: Function,
        //    isDirectory: Function,
        // }
    });

This example returns an array if stat objects.

WebDAV-fs

Once WebDAV-fs has been setup with a remote location, it too can be wrapped by any-fs:

const wfs = require("webdav-fs")(
    "http://example.com/webdav/",
    "username",
    "password"
);
const anyFs = require("any-fs");

const afs = anyFs(fs);
afs
    .readFile("/movie.mp4")
    .then(function(data) {
        // `data` is a Buffer
    });

API

Any-fs supports a few handy commands.

readDirectory(directoryPath[, options])

Read the contents of a directory, returning a Promise with an array of stats (refer to the stat output of the wrapped fs module).

Parameter	Type	Description
directoryPath	String	The path to scan
options	String or Object	Encoding (string) or config options (object)

options may contain properties mode and encoding (mode being either "node" or "stat"), but it is essentially passed down into whatever fs interface is being wrapped.

options is not used for readdir in Node's 'fs' module.

readFile(filePath[, options])

Read the contents of a file, returning a Promise with a Buffer or string.

Parameter	Type	Description
filePath	String	The file to read
options	String or Object	Encoding (string) or config options (object)

options.encoding is set to null by default, returning the raw buffer. Use "utf8" to convert it to a UTF8 string.

stat(filePath)

Get statistics on a file or directory - returns a Promise with the stat object.

Parameter	Type	Description
filePath	String	The file or directory to check

writeFile(filePath, data[, encoding])

Write data to a file - returns a Promise that resolves after writing has completed.

Parameter	Type	Description
filePath	String	The file to write to
data	Buffer or String	The data to write
encoding	String or undefined	The encoding to use for writing. utf8 writes text.

Changelog

v0.4.1

2017-09-12

• Bugfix: Dropbox writeFile called incorrectly