All Projects → anyfs → anyfs

anyfs / anyfs

Licence: MIT License
Portable file system for Node

Programming Languages

javascript
137047 projects - #8 most used programming language

Projects that are alternatives of or similar to anyfs

Gulp Ftp
[DEPRECATED] Upload files to an FTP-server
Stars: ✭ 100 (+488.24%)
Mutual labels:  gulp, gulp-plugin, ftp
Oneupflysystembundle
A Flysystem integration for your Symfony projects.
Stars: ✭ 541 (+3082.35%)
Mutual labels:  dropbox, filesystem, aws-s3
Vscode Remote Workspace
Multi protocol support for handling remote files like local ones in Visual Studio Code.
Stars: ✭ 197 (+1058.82%)
Mutual labels:  dropbox, filesystem, ftp
Gulp Ngmin
[DEPRECATED] Pre-minify AngularJS apps with ngmin
Stars: ✭ 89 (+423.53%)
Mutual labels:  gulp, gulp-plugin
Gulp Develop Server
Development assistant for node.js server by gulp
Stars: ✭ 72 (+323.53%)
Mutual labels:  gulp, gulp-plugin
Gulp Plugin Boilerplate
Boilerplate to kickstart creating Gulp plugins
Stars: ✭ 74 (+335.29%)
Mutual labels:  gulp, gulp-plugin
Gulp Jsonlint
🔍 jsonlint plugin for Gulp
Stars: ✭ 26 (+52.94%)
Mutual labels:  gulp, gulp-plugin
Gulp Bro
👊 gulp + browserify + incremental build, done right.
Stars: ✭ 119 (+600%)
Mutual labels:  gulp, gulp-plugin
Gulp Flatten
Gulp plugin: remove or replace relative paths for files
Stars: ✭ 102 (+500%)
Mutual labels:  gulp, gulp-plugin
Glup
Some of the gulp tutorial -《gulp笔记》
Stars: ✭ 136 (+700%)
Mutual labels:  gulp, gulp-plugin
gulp-px2rem
This is a gulp plugin for node-px2rem.
Stars: ✭ 19 (+11.76%)
Mutual labels:  gulp, gulp-plugin
Gulp Json Editor
A gulp plugin to edit JSON objects
Stars: ✭ 55 (+223.53%)
Mutual labels:  gulp, gulp-plugin
Gulp Require Tasks
Splits Gulpfile into multiple individual files
Stars: ✭ 51 (+200%)
Mutual labels:  gulp, gulp-plugin
Generator Gulp Plugin Boilerplate
Scaffold out a Gulp plugin boilerplate
Stars: ✭ 46 (+170.59%)
Mutual labels:  gulp, gulp-plugin
Gulp Html Replace
Replace build blocks in HTML. Like useref but done right.
Stars: ✭ 222 (+1205.88%)
Mutual labels:  gulp, gulp-plugin
gulp-recess
[DEPRECATED] Lint CSS and LESS with RECESS
Stars: ✭ 42 (+147.06%)
Mutual labels:  gulp, gulp-plugin
Gulp Modernizr
Gulp wrapper for custom Modernizr builds
Stars: ✭ 111 (+552.94%)
Mutual labels:  gulp, gulp-plugin
gulp-iife
A Gulp plugin for wrapping JavaScript code in IIFEs.
Stars: ✭ 39 (+129.41%)
Mutual labels:  gulp, gulp-plugin
Gulp Pug
Gulp plugin for compiling Pug templates
Stars: ✭ 512 (+2911.76%)
Mutual labels:  gulp, gulp-plugin
Gulp Angular Templatecache
Concatenates and registers AngularJS templates in the $templateCache.
Stars: ✭ 530 (+3017.65%)
Mutual labels:  gulp, gulp-plugin

anyfs

npm npm Travis npm

AnyFS is a portable filesystem abstraction for Node. It aims to provide a consistent API for different file systems.

WARNING: AnyFS is under heavy development, things may change at any time! a

Features

  • Extensible with plugins
  • Super portable with file system adapters
  • Works well with Gulp (vinyl-fs plugin)
  • API with Promise support

Adapters

AnyFS comes with following adapters.

  • Dropbox - NPM: anyfs-dropbox-adapter
  • FTP - NPM: anyfs-ftp-adapter
  • AWS S3 - NPM: anyfs-s3-adapter
  • Memory - Builtin, access with AnyFS.MemoryAdapter
  • Local: local file system
  • SFTP
  • Baidu
  • GIT
  • SVN

Plugins

  • Core: builtin, basic filesystem support.
  • glob: match files easily.
  • vinyl-fs: vinyl-fs port, works well with gulp

Usage

var AnyFs = require('anyfs');
var FtpAdapter = require('anyfs-ftp-adapter');
var DropboxAdapter = require('anyfs-dropbox-adapter');
var VinylFsPlugin = require('anyfs-vinyl-fs-plugin');
AnyFS.addPlugin(new VinylFsPlugin());

var fs1 = new AnyFS(new FtpAdapter({
    server: 'ftp.example.com',
    username: 'user',
    password: 'password',
}));

var fs2 = new AnyFS(new DropboxAdapter({
    key: 'appkey',
    secret: 'appsecret',
    token: 'token',
}));

// Copy files across filesystems(requires the vinyl-fs plugin)
fs1.src('/**/*.jpg')
    .pipe(fs2.dest('/backup/abc/'));

// Promise style API
fs1.mkdir('/doc')
    .then(function() {
        return this.writeFile('/doc/index.md', "content");
    })
    .then(function() {
        return this.metadata('/doc/index.md');
    })
    .done(function(metadata) {
        console.log(metadata.size);
    }, function(err) {
        console.log('Error occured: ', err);
    });

// callback API
fs.mkdir('/doc', function(err) {
    if (err) {
        console.log(err);
    } else {
        console.log('mkdir ok');
    }
});

API

Core API

Following APIs are basic file system APIs.

constructor(adapter, options)

The constructor accepts an adapter and an options object.

Common options:

  • cwd: Current working directory.

metadata(path[, callback(error, metadata)])

Retrieves file and folder metadata.

Folder metadata:

{
    "name": "dir1",
    "time": [Date Object],
    "is_dir": true,
}

File metadata:

{
    "name": "file1.txt",
    "time": [Date Object],
    "is_dir": false,
    "size": 123,
    ...
}

If callback is not provided, a promise is returned.

list(path[, callback(error, list)])

Get contents of directory.

[
    {
        // metadata
    },
    ...
]

mkdir(path[, callback(error)])

Create directory recursively.

If callback is not provided, a promise is returned.

delete(path[, callback(error)])

Delete file.

If callback is not provided, a promise is returned.

deleteDir(path[, callback(error)])

Delete directory recursively.

If callback is not provided, a promise is returned.

move(oldPath, newPath[, callback(error)])

Move file or directory to a new place.

Parent folder of newPath is created automaticly.

If callback is not provided, a promise is returned.

writeFile(path, content[, options][, callback(error)])

Write file content, will try to create parent directory.

If callback is not provided, a promise is returned.

readFile(path[, options][, callback(error, data)])

Read file content.

If callback is not provided, a promise is returned.

createWriteStream(path[, options])

Create write stream.

createReadStream(path[, options])

Create read stream.

Extra API

Extra APIs are supported by plugins

Create Custom Adapters

See adapter specification

Create Plugins

Acknowledgement

Logo by denjello

Inspired by Flysystem

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected]