Suite.js Documentation

Introduction

• What is Suite.js?
• Technologies Used
• ECMAScript Support
• License
• Roadmap

Getting Started

• Downloading & Installing
• Running
• Examples

Technical Support

• LinkedIn Support Group

Functions

Cryptography
• hashSHA256
• hmacSHA256
• hashSHA512
• hmacSHA512
• hashMD5
• hmacMD5

File System
• fileExists
• fileRead
• fileWrite
• folderExists
• unzip
• zip

Input / Output
• beep
• prompt
• write
• writeln

Networking
• curlExecute
• nsapiExecute

Operating System
• shellExecute

Text Encoding
• base64Decode
• base64Encode

Utilities
• abort / halt / quit
• info
• infoRefresh
• sleep
• stringIndent
• uuidGenerate

Advanced Topics

• Command Line Arguments
• Error Handling
• File Paths
• Includes
• Modules
• Source File Encryption
• TextBlocks

curl Properties

The Suite.js curlExecute function is powered by the libcurl library, and was implemented in Suite.js using Monkeybread Software's MBS CURL Xojo plugin. Specifically, the Suite.JS curlExecute function uses that plugin's CURLS class.

curlExecute has been designed to expose as much of the underlying libcurl library as possible. As a result, curlExecute supports a very wide range of options. The complete list of options that are supported is shown below.

For details about a specific function, refer to the CURLSMBS class as documented here. Specifically, refer to the properties of the class.

Property Name	Type	Default	Readable	Writable
APILoaded	Boolean	true	true	false
Cancel	Boolean	false	true	true
CollectDebugData	Boolean	false	true	true
CollectDebugMessages	Boolean	false	true	true
CollectHeaderData	Boolean	false	true	true
CollectHeaders	Boolean	false	true	true
CollectOutputData	Boolean	false	true	true
DebugData	String		true	false
DebugMessages	String		true	false
DebugWithData	Boolean	false	true	true
Handle	Int64	5024871424	true	true
HeaderData	String		true	false
Headers	String		true	false
InputData	String		true	true
LastError	Int64	0	true	true
LastErrorText	String		true	true
LasterrorMessage	String		true	false
LibVersion	String	libcurl/8.12.1 OpenSSL/3.3.3 (SecureTransport) zlib/1.3.1 zstd/1.5.2 AppleIDN libssh2/1.11.1	true	false
LibraryUsed	String	Internal with OpenSSL	true	false
OptionAWSSigV4	String		true	true
OptionAbstractUnixSocket	String		true	true
OptionAcceptEncoding	String		true	true
OptionAcceptTimeoutMS	Int64	0	true	true
OptionAddressScope	Int64	0	true	true
OptionAppend	Boolean	false	true	true
OptionAutoReferer	Boolean	false	true	true
OptionBufferSize	Int64	0	true	true
OptionCACacheTimeout	Int64	0	true	true
OptionCAInfo	String		true	true
OptionCAInfoBlob	String		true	true
OptionCAPath	String		true	true
OptionCRLF	Boolean	false	true	true
OptionCRLFile	String		true	true
OptionCertInfo	Boolean	false	true	true
OptionConnectOnly	Int64	0	true	true
OptionConnectionTimeOutMS	Int64	0	true	true
OptionConnectionTimeout	Int64	10	true	true
OptionCookie	String		true	true
OptionCookieFile	String		true	true
OptionCookieJar	String		true	true
OptionCookieList	String		true	true
OptionCookieSession	Boolean	false	true	true
OptionCustomRequest	String	GET	true	true
OptionDNSCacheTimeout	Int64	60	true	true
OptionDNSInterface	String		true	true
OptionDNSLocalIPv4	String		true	true
OptionDNSLocalIPv6	String		true	true
OptionDNSServers	String		true	true
OptionDNSShuffleAddresses	Boolean	false	true	true
OptionDOHSSLVerifyHost	Int64	2	true	true
OptionDOHSSLVerifyPeer	Int64	1	true	true
OptionDOHSSLVerifyStatus	Int64	0	true	true
OptionDOHURL	String		true	true
OptionDefaultProtocol	String		true	true
OptionDirListOnly	Boolean	false	true	true
OptionDisableUserNameInURL	Boolean	false	true	true
OptionEGDSocket	String		true	true
OptionExpect100TimeoutMS	Int64	1000	true	true
OptionFTPAccount	String		true	true
OptionFTPAlternativeToUser	String		true	true
OptionFTPAppend	Boolean	false	true	true
OptionFTPCreateMissingDirs	Int64	0	true	true
OptionFTPFileMethod	Int64	1	true	true
OptionFTPListOnly	Boolean	false	true	true
OptionFTPPort	String		true	true
OptionFTPResponseTimeout	Int64	0	true	true
OptionFTPSSL	Int64	0	true	true
OptionFTPSSLAuth	Int64	0	true	true
OptionFTPSSLCCC	Int64	0	true	true
OptionFTPSkipPasvIP	Boolean	false	true	true
OptionFTPUseEPRT	Boolean	true	true	true
OptionFTPUseEPSV	Boolean	true	true	true
OptionFTPusePret	Boolean	false	true	true
OptionFailOnError	Boolean	false	true	true
OptionFileTime	Boolean	false	true	true
OptionFollowLocation	Boolean	false	true	true
OptionForbidReuse	Boolean	false	true	true
OptionFreshConnect	Boolean	false	true	true
OptionGSSAPIDelegation	Int64	0	true	true
OptionGet	Boolean	false	true	true
OptionHAProxyProtocol	Boolean	false	true	true
OptionHTTPAuth	Int64	1	true	true
OptionHTTPContentDecoding	Int64	1	true	true
OptionHTTPProxyTunnel	Boolean	false	true	true
OptionHTTPTransferDecoding	Int64	1	true	true
OptionHTTPVersion	Int64	2	true	true
OptionHappyEyeballsTimeOutMS	Int64	200	true	true
OptionHeader	Boolean	false	true	true
OptionHeaderOptions	Int64	0	true	true
OptionIPResolve	Int64	0	true	true
OptionIgnoreContentLength	Boolean	false	true	true
OptionInFileSize	Int64	0	true	true
OptionInFileSizeLarge	Int64	0	true	true
OptionInterface	String		true	true
OptionIssuerCert	String		true	true
OptionIssuerCertBlob	String		true	true
OptionKRB4Level	String		true	true
OptionKRBLevel	String		true	true
OptionKeepSendingOnError	Int64	0	true	true
OptionKeyPassword	String		true	true
OptionLocalPort	Int64	0	true	true
OptionLocalPortRange	Int64	0	true	true
OptionLoginOptions	String		true	true
OptionLowSpeedLimit	Int64	0	true	true
OptionLowSpeedTime	Int64	0	true	true
OptionMailAuth	String		true	true
OptionMailFrom	String		true	true
OptionMaxAgeConn	Int64	118	true	true
OptionMaxConnects	Int64	0	true	true
OptionMaxFileSize	Int64	0	true	true
OptionMaxFileSizeLarge	Int64	0	true	true
OptionMaxLifeTimeConnection	Int64	0	true	true
OptionMaxRecvSpeed	Int64	0	true	true
OptionMaxRecvSpeedLarge	Int64	0	true	true
OptionMaxRedirs	Int64	0	true	true
OptionMaxSendSpeed	Int64	0	true	true
OptionMaxSendSpeedLarge	Int64	0	true	true
OptionMimeOptions	Int64	0	true	true
OptionNetRC	Int64	0	true	true
OptionNetRCFile	String		true	true
OptionNewDirectoryPerms	Int64	493	true	true
OptionNewFilePerms	Int64	420	true	true
OptionNoBody	Boolean	false	true	true
OptionNoProxy	String		true	true
OptionNoSignal	Int64	1	true	true
OptionPassword	String		true	true
OptionPathAsIs	Boolean	false	true	true
OptionPinnedPublicKey	String		true	true
OptionPipeWait	Boolean	false	true	true
OptionPort	Int64	0	true	true
OptionPost	Boolean	false	true	true
OptionPostFieldSize	Int64	0	true	true
OptionPostFieldSizeLarge	Int64	0	true	true
OptionPostFields	String		true	true
OptionPostRedir	Int64	0	true	true
OptionPreProxy	String		true	true
OptionProtocols	Int64	0	true	true
OptionProtocolsString	String		true	true
OptionProxy	String		true	true
OptionProxyAuth	Int64	1	true	true
OptionProxyCAInfo	String		true	true
OptionProxyCAInfoBlob	String		true	true
OptionProxyCAPath	String		true	true
OptionProxyCRLFile	String		true	true
OptionProxyIssuerCert	String		true	true
OptionProxyIssuerCertBlob	String		true	true
OptionProxyKeyPassword	String		true	true
OptionProxyPassword	String		true	true
OptionProxyPinnedPublicKey	String		true	true
OptionProxyPort	Int64	0	true	true
OptionProxySSLCert	String		true	true
OptionProxySSLCertBlob	String		true	true
OptionProxySSLCertType	String		true	true
OptionProxySSLCipherList	String		true	true
OptionProxySSLKey	String		true	true
OptionProxySSLKeyBlob	String		true	true
OptionProxySSLKeyType	String		true	true
OptionProxySSLOptions	Int64	0	true	true
OptionProxySSLVerifyHost	Int64	0	true	true
OptionProxySSLVerifyPeer	Int64	0	true	true
OptionProxySSLVersion	Int64	0	true	true
OptionProxyServiceName	String		true	true
OptionProxyTLS13Ciphers	String		true	true
OptionProxyTLSAuthPassword	String		true	true
OptionProxyTLSAuthType	String		true	true
OptionProxyTLSAuthUsername	String		true	true
OptionProxyTransferMode	Int64	0	true	true
OptionProxyType	Int64	0	true	true
OptionProxyUsername	String		true	true
OptionPut	Boolean	false	true	true
OptionQuickExit	Int64	0	true	true
OptionRTSPClientCSEQ	Int64	0	true	true
OptionRTSPRequest	Int64	1	true	true
OptionRTSPServerCSEQ	Int64	0	true	true
OptionRTSPSessionID	String		true	true
OptionRTSPStreamURI	String		true	true
OptionRTSPTransport	String		true	true
OptionRandomFile	String		true	true
OptionRange	String		true	true
OptionRedirProtocols	Int64	15	true	true
OptionReditProtocolsString	String		true	true
OptionReferer	String		true	true
OptionRequestTarget	String		true	true
OptionResumeFrom	Int64	0	true	true
OptionResumeFromLarge	Int64	0	true	true
OptionSASLAuthZID	String		true	true
OptionSASLIR	Int64	0	true	true
OptionSSHAuthTypes	Int64	-1	true	true
OptionSSHCompression	Boolean	false	true	true
OptionSSHHostPublicKeyMD5	String		true	true
OptionSSHHostPublicKeySHA256	String		true	true
OptionSSHKnownhosts	String		true	true
OptionSSHPrivateKeyfile	String		true	true
OptionSSHPublicKeyfile	String		true	true
OptionSSLCert	String		true	true
OptionSSLCertBlob	String		true	true
OptionSSLCertPassword	String		true	true
OptionSSLCertType	String		true	true
OptionSSLCipherList	String		true	true
OptionSSLEnableALPN	Int64	1	true	true
OptionSSLEnableNPN	Int64	0	true	true
OptionSSLEngine	String		true	true
OptionSSLEngineDefault	Int64	0	true	true
OptionSSLFalseStart	Int64	0	true	true
OptionSSLKey	String		true	true
OptionSSLKeyBlob	String		true	true
OptionSSLKeyPassword	String		true	true
OptionSSLKeyType	String		true	true
OptionSSLOptions	Int64	0	true	true
OptionSSLSessionIDCache	Boolean	false	true	true
OptionSSLVerifyHost	Int64	-1	true	true
OptionSSLVerifyPeer	Int64	-1	true	true
OptionSSLVerifyStatus	Int64	0	true	true
OptionSSLVersion	Int64	0	true	true
OptionServerResponseTimeout	Int64	0	true	true
OptionServiceName	String		true	true
OptionSocks5Auth	Int64	5	true	true
OptionSocks5GSSAPINEC	Boolean	false	true	true
OptionSocks5GSSAPIService	String		true	true
OptionStreamDepends	CURLSMBS	null	true	true
OptionStreamDependsE	CURLSMBS	null	true	true
OptionStreamWeight	Int64	0	true	true
OptionSuppressConnectHeaders	Boolean	false	true	true
OptionTCPFastOpen	Int64	0	true	true
OptionTCPKeepAlive	Boolean	false	true	true
OptionTCPKeepIdle	Int64	60	true	true
OptionTCPKeepInterval	Int64	60	true	true
OptionTCPNoDelay	Boolean	true	true	true
OptionTFTPBlockSize	Int64	0	true	true
OptionTFTPNoOptions	Int64	0	true	true
OptionTLS13Ciphers	String		true	true
OptionTLSAuthPassword	String		true	true
OptionTLSAuthType	String		true	true
OptionTLSAuthUsername	String		true	true
OptionTimeCondition	Int64	0	true	true
OptionTimeOut	Int64	0	true	true
OptionTimeOutMS	Int64	0	true	true
OptionTimeValue	Int64	0	true	true
OptionTransferEncoding	Boolean	false	true	true
OptionTransferText	Boolean	false	true	true
OptionURL	String	https://swapi.dev/api/films/1/	true	true
OptionUnixSocketPath	String		true	true
OptionUnrestrictedAuth	Boolean	false	true	true
OptionUpkeepIntervalMS	Int64	60000	true	true
OptionUpload	Boolean	false	true	true
OptionUploadBufferSize	Int64	0	true	true
OptionUseSSL	Int64	0	true	true
OptionUserAgent	String		true	true
OptionUsername	String		true	true
OptionVerbose	Boolean	true	true	true
OptionWildcardMatch	Boolean	false	true	true
OptionXOAuth2Bearer	String		true	true
OutputData	String		true	false
Paused	Boolean	false	true	true
ProgressDownloadCurrent	Int64	0	true	false
ProgressDownloadTotal	Int64	0	true	false
ProgressPercent	Double	0	true	false
ProgressUploadCurrent	Int64	0	true	false
ProgressUploadTotal	Int64	0	true	false
Tag	Variant	null	true	true
WebSocketOptions	Int64	0	true	true
YieldTime	Boolean	true	true	true