Class: URI

ui.URI(optionsopt, nullable)

URI Represents a handshake URI.

Constructor

new URI(optionsopt, nullable)

Create a handshake URI.

Parameters:
Name Type Attributes Description
options URIOptions | String <optional>
<nullable>
Properties:
Name Type Description
address Address
amount AmountValue
label String | null
message String | null
request String | null
Source:

Members

(nullable) label :String

Type:
  • String
Source:

(nullable) message :String

Type:
  • String
Source:

(nullable) request :String

Type:
  • String
Source:

Methods

(static) fromOptions(options) → {URI}

Instantiate URI from options.

Parameters:
Name Type Description
options URIOptions | String
Source:
Returns:
Type
URI

(static) fromString(str, networkopt, nullable) → {URI}

Instantiate uri from string.

Parameters:
Name Type Attributes Description
str String
network NetworkType | Network <optional>
<nullable>
Source:
Returns:
Type
URI

fromOptions(options) → {URI}

Inject properties from options object.

Parameters:
Name Type Description
options URIOptions | String
Source:
Returns:
Type
URI

(private) fromString(str, networkopt, nullable) → {URI}

Parse and inject properties from string.

Parameters:
Name Type Attributes Description
str String
network NetworkType | Network <optional>
<nullable>
Source:
Returns:
Type
URI

inspect() → {String}

Inspect handshake uri.

Source:
Returns:
Type
String

toString() → {String}

Serialize uri to a string.

Source:
Returns:
Type
String