types.md

Qusly-Core documentation

Table of contents

• Types and interfaces
  • IConfig
  • IOptions
  • ISftpOptions
  • IFtpOptions
  • IFtpsOptions
  • IFilePermissions
  • IFileType
  • IFile
  • IConcurrentTransferInfo
  • IConcurrentTransferStatus
  • IProtocol
  • IStats
  • ITransferInfo
  • ITransferOptions
  • ITransferProgress
  • ITransferStatus
  • ITransferType

Interface IConfig

• protocol IProtocol
• host String
• user String
• password String
• port Number (optional)

Interface IOptions

• sftp ISftpOptions
• ftp IFtpOptions
• ftps IFtpsOptions

Interface ISftpOptions

• tryKeyboard Boolean

Interface IFtpOptions

Interface IFtpsOptions

• secureOptions ConnectionOptions

Interface IFilePermissions

• user Number (optional)
• group Number (optional)

Type IFileType

• 'file' | 'folder' | 'unknown' | 'symbolic-link'

Interface IFile

• name String (optional)
• type IFileType (optional)
• size Number (optional)
• user String (optional)
• group String (optional)
• date Date (optional)
• ext String (optional)
• permissions IFilePermissions (optional)

Interface IConcurrentTransferInfo

• id String - Unique id of a transfer
• localPath String
• remotePath String
• status IConcurrentTransferStatus
• type ITransferType

Type IConcurrentTransferStatus

• 'pending' | 'transfering' | ITransferStatus

Type IProtocol

• 'ftp' | 'ftps' | 'sftp'

Interface IStats

• size Number (optional)
• type IFileType (optional)

Interface ITransferInfo

• type ITransferType
• localPath String
• remotePath String
• startAt Date - When a transfer has stared
• context Client

Interface ITransferOptions

• quiet Boolean (optional) - Blocks the progress event from emitting
• startAt Number (optional) - Offset of a file

Interface ITransferProgress

• buffered Number
• eta Number - estimated time arrival in seconds
• speed Number - speed rate in KB/s
• percent Number
• size Number - size of a transfered file

Type ITransferStatus

• 'finished' | 'aborted' | 'closed'

Type ITransferType

• 'download' | 'upload'