Class Invoice

An Invoice is used to know whether a transaction or a parcel succeeded or failed.

Hierarchy

Invoice

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Invoice(success: boolean, error?: undefined | object): Invoice

- Defined in core/Invoice.ts:19
Parameters
- success: boolean
  
  Whether a transaction or a parcel succeeded or failed.
- Optional error: undefined | object
Returns Invoice

Properties

Optional error

error: undefined | object

success

success: boolean

Methods

toJSON

toJSON(): object

- Defined in core/Invoice.ts:35
Convert to an Invoice JSON object.

Returns object

An Invoice JSON object.
- error: undefined | object
- success: boolean

Static fromJSON

fromJSON(data: object): Invoice

- Defined in core/Invoice.ts:11
Create an Invoice from an Invoice JSON object.

Parameters
- data: object
  
  An Invoice JSON object.
  - Optional error?: undefined | object
  - success: boolean
Returns Invoice

An Invoice.

Generated using TypeDoc