@webdav-server/ftp/README.md

FTP file system for webdav-server

# FTP File System for webdav-server
> webdav-server version 2

[![npm Version](https://img.shields.io/npm/v/@webdav-server/ftp.svg)](https://www.npmjs.com/package/@webdav-server/ftp)

## Install

```bash
npm install @webdav-server/ftp
```

## Usage

```javascript
// TypeScript
import { v2 as webdav } from 'webdav-server'
import * as ftp from '@webdav-server/ftp'
// JavaScript
const webdav = require('webdav-server').v2,
      ftp = require('@webdav-server/ftp');

const server = new webdav.WebDAVServer({
    // [...]
    autoLoad: {
        // [...]
        serializers: [
            new ftp.FTPSerializer()
            // [...]
        ]
    }
})

server.autoLoad((e) => {
    if(!e)
        return;
    
    server.setFileSystem('/myFTPGateway', new ftp.FTPFileSystem({
        host: '127.0.0.1',
        port: 21,
        connTimeout: 1000,
        pasvTimeout: 1000,
        user: 'username',
        password: 'password'
    }));
});

server.start((s) => console.log('Ready on port', s.address().port));
```