Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/perry-mitchell/any-fs
Abstract away any filesystem (NodeJS) instance to a smarter interface
https://github.com/perry-mitchell/any-fs
dropbox filesystem fs nextcloud owncloud webdav
Last synced: 2 months ago
JSON representation
Abstract away any filesystem (NodeJS) instance to a smarter interface
- Host: GitHub
- URL: https://github.com/perry-mitchell/any-fs
- Owner: perry-mitchell
- License: mit
- Created: 2016-11-19T10:34:24.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-09-12T19:43:11.000Z (over 7 years ago)
- Last Synced: 2024-09-28T11:42:13.428Z (3 months ago)
- Topics: dropbox, filesystem, fs, nextcloud, owncloud, webdav
- Language: JavaScript
- Size: 35.2 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Any-fs
Abstract away any filesystem (NodeJS) instance to a smarter interface
[](https://travis-ci.org/perry-mitchell/any-fs)  [](https://www.npmjs.com/package/any-fs)
## Purpose
Any-fs was designed to wrap filesystem interfaces like the following:
* Node's [fs](https://nodejs.org/api/fs.html)
* [WebDAV-fs](https://github.com/perry-mitchell/webdav-fs)
* [Dropbox-fs](https://github.com/sallar/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:
```javascript
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](https://nodejs.org/api/fs.html#fs_class_fs_stats) objects.
### WebDAV-fs
Once WebDAV-fs has been setup with a remote location, it too can be wrapped by any-fs:
```javascript
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.|