modules.md

@guestbell/fast-ftp / Exports

@guestbell/fast-ftp

Table of contents

Classes

• ItemPool

Interfaces

• AsyncClient
• ClientConfig
• ClientError
• DeployConfig

Type Aliases

• FtpFunctionConfig
• WinstonLogLevel

Variables

• WinstonLogLevels

Functions

• createLogger
• createLoggerFromPartialConfig
• deleteDirectories
• deleteDirectory
• deleteFiles
• deploy
• dirsToParallelBatches
• getAllDirDirs
• getAllDirFiles
• getAllRemote
• getClientConfig
• getClients
• getDeployConfig
• getFinalFtpConfig
• getFtpFunctionConfig
• removeKeys
• sortFilesBySize
• uploadDirectories
• uploadDirectory
• uploadFiles

Type Aliases

FtpFunctionConfig

Ƭ FtpFunctionConfig: Object

Type declaration

Name	Type
logLevel	WinstonLogLevel
retries	number

Defined in

src/types/FtpFunctionConfig.ts:3

---

WinstonLogLevel

Ƭ WinstonLogLevel: "error" | "warn" | "info" | "http" | "verbose" | "debug" | "silly"

Defined in

src/utils/misc/logger.ts:22

Variables

WinstonLogLevels

• Const WinstonLogLevels: WinstonLogLevel[]

Defined in

src/utils/misc/logger.ts:31

Functions

createLogger

▸ createLogger(level): Logger

Parameters

Name	Type
level	WinstonLogLevel

Returns

Logger

Defined in

src/utils/misc/logger.ts:5

---

createLoggerFromPartialConfig

▸ createLoggerFromPartialConfig(config): Logger

Parameters

Name	Type
config	Partial<FtpFunctionConfig>

Returns

Logger

Defined in

src/utils/misc/logger.ts:18

---

deleteDirectories

▸ deleteDirectories(config): (clientPool: ItemPool<AsyncClient>, allDirs: string[]) => Promise<void>

Parameters

Name	Type
config	Partial<FtpFunctionConfig>

Returns

fn

▸ (clientPool, allDirs): Promise<void>

Parameters

Name	Type
clientPool	ItemPool<AsyncClient>
allDirs	string[]

Returns

Promise<void>

Defined in

src/utils/ftp/deleteDirectories.ts:10

---

deleteDirectory

▸ deleteDirectory(config): (clientPool: ItemPool<AsyncClient>, remoteDir: string) => Promise<void>

Parameters

Name	Type
config	Partial<FtpFunctionConfig>

Returns

fn

▸ (clientPool, remoteDir): Promise<void>

Parameters

Name	Type
clientPool	ItemPool<AsyncClient>
remoteDir	string

Returns

Promise<void>

Defined in

src/utils/ftp/deleteDirectory.ts:9

---

deleteFiles

▸ deleteFiles(config): (clientPool: ItemPool<AsyncClient>, allFiles: string[]) => Promise<void>

Parameters

Name	Type
config	Partial<FtpFunctionConfig>

Returns

fn

▸ (clientPool, allFiles): Promise<void>

Parameters

Name	Type
clientPool	ItemPool<AsyncClient>
allFiles	string[]

Returns

Promise<void>

Defined in

src/utils/ftp/deleteFiles.ts:6

---

deploy

▸ deploy(deployConfig, clientConfig, ftpFunctionConfig): Promise<void>

Parameters

Name	Type
deployConfig	DeployConfig
clientConfig	ClientConfig
ftpFunctionConfig	Partial<FtpFunctionConfig>

Returns

Promise<void>

Defined in

src/core/deploy.ts:16

---

dirsToParallelBatches

▸ dirsToParallelBatches(dirs): string[][]

Parameters

Name	Type
dirs	string[]

Returns

string[][]

Defined in

src/utils/misc/dirsToParallelBatches.ts:1

---

getAllDirDirs

▸ getAllDirDirs(dirPath, arrayOfFiles?): string[]

Parameters

Name	Type	Default value
dirPath	string	undefined
arrayOfFiles	string[]	[]

Returns

string[]

Defined in

src/utils/fs/getAllDirDirs.ts:3

---

getAllDirFiles

▸ getAllDirFiles(dirPath, arrayOfFiles?): string[]

Parameters

Name	Type	Default value
dirPath	string	undefined
arrayOfFiles	string[]	[]

Returns

string[]

Defined in

src/utils/fs/getAllDirFiles.ts:4

---

getAllRemote

▸ getAllRemote(config): (itemPool: ItemPool<AsyncClient>, remoteDir: string) => Promise<ListingElement[]>

Parameters

Name	Type
config	Partial<FtpFunctionConfig>

Returns

fn

▸ (itemPool, remoteDir): Promise<ListingElement[]>

Parameters

Name	Type
itemPool	ItemPool<AsyncClient>
remoteDir	string

Returns

Promise<ListingElement[]>

Defined in

src/utils/ftp/getAllRemote.ts:7

---

getClientConfig

▸ getClientConfig(): ClientConfig

Returns

ClientConfig

Defined in

src/utils/misc/getClientConfig.ts:3

---

getClients

▸ getClients(config): (concurrency: number, config: ClientConfig) => Promise<AsyncClient[]>

Parameters

Name	Type
config	Partial<FtpFunctionConfig>

Returns

fn

▸ (concurrency?, config): Promise<AsyncClient[]>

Parameters

Name	Type	Default value
concurrency	number	30
config	ClientConfig	undefined

Returns

Promise<AsyncClient[]>

Defined in

src/utils/ftp/getClients.ts:11

---

getDeployConfig

▸ getDeployConfig(): DeployConfig

Returns

DeployConfig

Defined in

src/utils/misc/getDeployConfig.ts:4

---

getFinalFtpConfig

▸ getFinalFtpConfig(config): Object

Parameters

Name	Type
config	Partial<FtpFunctionConfig>

Returns

Object

Name	Type
logLevel	WinstonLogLevel
retries	number

Defined in

src/utils/misc/getFinalFtpConfig.ts:4

---

getFtpFunctionConfig

▸ getFtpFunctionConfig(): FtpFunctionConfig

Returns

FtpFunctionConfig

Defined in

src/utils/misc/getFtpFunctionConfig.ts:6

---

removeKeys

▸ removeKeys(obj, keys): object

Parameters

Name	Type
obj	any
keys	string[]

Returns

object

Defined in

src/utils/misc/removeKeys.ts:1

---

sortFilesBySize

▸ sortFilesBySize(files): string[]

Parameters

Name	Type
files	string[]

Returns

string[]

Defined in

src/utils/fs/sortFilesBySize.ts:3

---

uploadDirectories

▸ uploadDirectories(config): (clientsPool: ItemPool<AsyncClient>, allDirs: string[], localDir: string, remoteDir: string) => Promise<void>

Parameters

Name	Type
config	Partial<FtpFunctionConfig>

Returns

fn

▸ (clientsPool, allDirs, localDir, remoteDir): Promise<void>

Parameters

Name	Type
clientsPool	ItemPool<AsyncClient>
allDirs	string[]
localDir	string
remoteDir	string

Returns

Promise<void>

Defined in

src/utils/ftp/uploadDirectories.ts:10

---

uploadDirectory

▸ uploadDirectory(config): (clientsPool: ItemPool<AsyncClient>, remoteDir: string, localDir: string) => Promise<void>

Parameters

Name	Type
config	Partial<FtpFunctionConfig>

Returns

fn

▸ (clientsPool, remoteDir, localDir): Promise<void>

Parameters

Name	Type
clientsPool	ItemPool<AsyncClient>
remoteDir	string
localDir	string

Returns

Promise<void>

Defined in

src/utils/ftp/uploadDirectory.ts:8

---

uploadFiles

▸ uploadFiles(config): (clientsPool: ItemPool<AsyncClient>, allFiles: string[], localDir: string, remoteDir: string) => Promise<void>

Parameters

Name	Type
config	Partial<FtpFunctionConfig>

Returns

fn

▸ (clientsPool, allFiles, localDir, remoteDir): Promise<void>

Parameters

Name	Type
clientsPool	ItemPool<AsyncClient>
allFiles	string[]
localDir	string
remoteDir	string

Returns

Promise<void>

Defined in

src/utils/ftp/uploadFiles.ts:11