README_EN.md

中文

FTP

Promisify FTP

• put

• rmDir

• mkDir

• getList

• emptyDir

• deleteFile

Install width npm

$ npm install @jiaminghi/ftp

Use

import { put, mkDir } from '@jiaminghi/ftp'

// do something

Examples

put

type put = (ftp: Client, src: string, dest: string) => Promise<boolean>

rmDir

type rmDir = (ftp: Client, src: string, recusive = true) => Promise<boolean>

mkDir

type mkDir = (ftp: Client, src: string, recusive = true) => Promise<boolean>

getList

type getList = (ftp: Client, src: string) => Promise<Client.ListingElement[] | false>

emptyDir

type emptyDir = (ftp: Client, src: string, except: string[] = []) => Promise<boolean>

deleteFile

type deleteFile = (ftp: Client, src: string) => Promise<boolean>