Class: URI

btc.URI(options)

URI Represents a bitcoin URI.

Constructor

new URI(options)

Create a bitcoin URI.

Parameters:
Name Type Description
options Object | String
Properties:
Name Type Description
address Address
amount Amount
label String | null
message String | null
request String | null
Source:

Methods

(static) fromOptions(options) → {URI}

Instantiate URI from options.

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

(static) fromString(str, networknullable) → {URI}

Instantiate uri from string.

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

(private) fromOptions(options) → {URI}

Inject properties from options object.

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

(private) fromString(str, networknullable) → {URI}

Parse and inject properties from string.

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

inspectSymbol() → {String}

Inspect bitcoin uri.

Source:
Returns:
Type
String

toString() → {String}

Serialize uri to a string.

Source:
Returns:
Type
String