webnet/packages/ftp

@webnet/ftp

FTP/FTPS client and server built on @webnet/transport and @webnet/vfs.

FTPClient implements AsyncVFS, so it can be used anywhere an AsyncVFS is expected (stat, readdir, readFile/readFileRange, writeFile, delete, mkdir, move). It supports plaintext FTP, implicit FTPS (TLS from the first byte, via dialer.dialTls), and explicit FTPS (plaintext control connection upgraded with AUTH TLS/PROT P). FTPServer serves an AsyncVFS over FTP, with optional per-login authenticate to select a different VFS per user and optional TLS credentials for explicit AUTH TLS. Errors from both sides surface as FTPError, carrying the underlying Reply.

Entry points

Entry point	Description
@webnet/ftp	FTPClient, FTPServer, FTPError, and their option/reply types.
@webnet/ftp/client	FTPClient and its option types only.
@webnet/ftp/server	FTPServer and its option types only.

_internals entry points are unstable and are not part of the public API.

Usage

Client

import { FTPClient } from "@webnet/ftp/client"
import type { RawDialer } from "@webnet/transport"

declare const dialer: RawDialer

const client = new FTPClient({ dialer, host: "ftp.example.com", user: "anonymous" })
const entries = await client.readdir("/pub")
const stream = await client.readFile("/pub/readme.txt")
await client.close()

Server

import { FTPServer } from "@webnet/ftp/server"
import type { RawListener } from "@webnet/transport"
import type { AsyncVFS } from "@webnet/vfs"

declare const vfs: AsyncVFS
declare const controlListener: RawListener
declare const dataListen: (port: number) => Promise<RawListener>

const server = new FTPServer({ vfs, dataListen })
await server.listen(controlListener)

See also

• @webnet/vfs — the AsyncVFS interface this package implements and serves
• @webnet/transport — the RawDialer/RawListener/RawTransport primitives this package is built on
• @webnet/sftp — an alternative file-transfer protocol over SSH instead of FTP