# @webdav-server/ftp

> FTP file system for webdav-server

Latest version **1.0.3** (published 2017-08-28) · Unlicense license · 0 weekly downloads

## Install

```sh
npm install @webdav-server/ftp
pnpm add @webdav-server/ftp
yarn add @webdav-server/ftp
bun add @webdav-server/ftp
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2017-08-28 |
| First published | 2017-06-30 |
| Weekly downloads | 0 |
| License | Unlicense |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >= 4 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13 |
| Author | Adrien Castex |
| Maintainers | adriencastex |
| Keywords | @webdav-server, webdav-server, file system, webdav, server, ftp |

## Links

- npm: https://www.npmjs.com/package/@webdav-server/ftp
- Repository: https://github.com/OpenMarshal/npm-WebDAV-Server-Types
- Homepage: https://github.com/OpenMarshal/npm-WebDAV-Server-Types#readme
- Issues: https://github.com/OpenMarshal/npm-WebDAV-Server-Types/issues
- npm.io page: https://npm.io/package/@webdav-server/ftp

## Dependencies (2)

- [ftp](https://npm.io/package/ftp.md) ^0.3.10
- [webdav-server](https://npm.io/package/webdav-server.md) ^2.0.2

## Recent versions

- 1.0.3 (latest) — 2017-08-28
- 1.0.2 — 2017-07-01
- 1.0.1 — 2017-06-30
- 1.0.0 — 2017-06-30

## README

# 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));
```

---
_Source: https://npm.io/package/@webdav-server/ftp · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._