CLIBuilder.md

CLIBuilder

Build a CLI object, defining the connection parameters to fatd and other network dependencies

Kind: global class
Access: public

• CLIBuilder
  • .host(host) ⇒ CLIBuilder
  • .port(port) ⇒ CLIBuilder
  • .timeout(timeout) ⇒ CLIBuilder
  • .secure([secure]) ⇒ CLIBuilder
  • .protocol([protocol]) ⇒ CLIBuilder
  • .username(username) ⇒ CLIBuilder
  • .password(password) ⇒ CLIBuilder
  • .pending([pending]) ⇒ CLIBuilder
  • .build() ⇒ CLI

cliBuilder.host(host) ⇒ CLIBuilder

Set the host information for connection to fatd. Defaults to localhost if host is not set.

Kind: instance method of CLIBuilder

Param	Type	Description
host	string	The host string of where the fatd RPC host can be found. For example 'node.fatd.org', 88.21.0.1

cliBuilder.port(port) ⇒ CLIBuilder

Set the port information for connection to fatd

Kind: instance method of CLIBuilder

Param	Type	Description
port	number	The port the fatd RPC host can be found on at the destination host

cliBuilder.timeout(timeout) ⇒ CLIBuilder

Set the connection timeout during connection to fatd

Kind: instance method of CLIBuilder

Param	Type	Description
timeout	number	The timeout in milliseconds before giving up

cliBuilder.secure([secure]) ⇒ CLIBuilder

Enforce strict security on https connections to fatd (forbid self signed certs, etc). Default false

Kind: instance method of CLIBuilder

Param	Type	Default	Description
[secure]	boolean	true	True if secure connection is desired, false if not

cliBuilder.protocol([protocol]) ⇒ CLIBuilder

Which transport protocol to use to contact fatd. Default "http"

Kind: instance method of CLIBuilder

Param	Type	Default	Description
[protocol]	number	"http"	The protocol to use. Either "http" or "https"

cliBuilder.username(username) ⇒ CLIBuilder

Set the username to use for basic HTTP authentication with fatd

Kind: instance method of CLIBuilder

Param	Type	Description
username	string	The username string to use

cliBuilder.password(password) ⇒ CLIBuilder

Set the password to use for basic HTTP authentication with fatd

Kind: instance method of CLIBuilder

Param	Type	Description
password	string	The password string to use

cliBuilder.pending([pending]) ⇒ CLIBuilder

Request a pending view of data & statistics from fatd based on transaction entries that have not made it to a dblock yet. Default false

Kind: instance method of CLIBuilder

Param	Type	Default	Description
[pending]	boolean	false	True if secure connection is desired, false if not

cliBuilder.build() ⇒ CLI

Build the CLI

Kind: instance method of CLIBuilder