Skip to content

Enums and XML types ​

All enums and types below are exported by @jalsoedesign/filezilla-core. Protocol IDs represent saved FileZilla values. Changing existing numeric IDs would reinterpret saved sites.

ServerProtocol ​

IDNameConnector
-1UNKNOWNNone
0FTPExplicit FTPS
1SFTPSFTP
2HTTPNone
3FTPSImplicit FTPS
4FTPESExplicit FTPS
5HTTPSNone
6INSECURE_FTPPlain FTP
7S3None
8STORJNone
9WEBDAVNone
10AZURE_FILENone
11AZURE_BLOBNone
12SWIFTNone
13GOOGLE_CLOUDNone
14GOOGLE_DRIVENone
15DROPBOXNone
16ONEDRIVENone
17B2None
18BOXNone
19INSECURE_WEBDAVNone
20RACKSPACENone
21STORJ_GRANTNone
22S3_SSONone
23GOOGLE_CLOUD_SVC_ACCNone
24CLOUDFLARE_R2None

MAX_VALUE remains an alias of CLOUDFLARE_R2 to preserve existing numeric values. Use server.siteProtocolName for display: it deliberately excludes the sentinel and returns CLOUDFLARE_R2 for ID 24. Raw numeric-enum reverse lookup still reflects TypeScript's alias behavior.

Other enums ​

EnumMembers in numeric order, starting at zero
LogonTypeanonymous, normal, ask, interactive, account, key, profile, adc, count
PasvModeMODE_DEFAULT, MODE_ACTIVE, MODE_PASSIVE
CharsetEncodingENCODING_UTF8, ENCODING_CUSTOM, ENCODING_AUTO
ServerTypeDEFAULT, UNIX, VMS, DOS, MVS, VXWORKS, ZVM, HPNONSTOP, DOS_VIRTUAL, CYGWIN, DOS_FWD_SLASHES, SERVERTYPE_MAX
ServerFormatHOST_ONLY, WITH_OPTIONAL_PORT, WITH_USER_AND_OPTIONAL_PORT, URL, URL_WITH_PASSWORD

count and SERVERTYPE_MAX are sentinels. ServerFormat is exported metadata; the library currently has no corresponding formatter implementation.

XML object types ​

XmlConfig contains FileZilla3: XmlRootFolderConfig; that root contains Servers: XmlFolderConfig. Folder types contain Server, Folder, and optional '#text' for their name. The public constructor supports singleton or array child fields, including mixed nested forms.

XmlServerConfig describes FileZilla's field names: Host, Port, Protocol, Type, User, Pass, Logontype, TimezoneOffset, PasvMode, MaximumMultipleConnections, EncodingType, CustomEncoding, BypassProxy, Name, Comments, LocalDir, RemoteDir, SyncBrowsing, DirectoryComparison, Keyfile.

Pass and Name may be text or an object with '#text' and '@_encoding'. XML parsing disables primitive value coercion and global trimming; the reader validates and normalizes supported fields deliberately. Type declarations alone are not validation for arbitrary direct Server or connector configuration objects.

Documentation for the filezilla-js library. An independent project.