Class ExportMnemonicDataSchema

Class ExportMnemonicDataSchema describes an export account QR code data schema.

since: 0.3.2

Hierarchy

QRCodeDataSchema
- ExportMnemonicDataSchema

Index

Constructors

constructor

Properties

VERSION

Methods

Constructors

constructor

new ExportMnemonicDataSchema(): ExportMnemonicDataSchema

Overrides QRCodeDataSchema.constructor
- Defined in schemas/ExportMnemonicDataSchema.ts:35
Returns ExportMnemonicDataSchema

Properties

Readonly VERSION

VERSION: 3 = 3

The AccountQR QR Code version

var: {number}

Methods

getData

getData(qr: MnemonicQR): any

Overrides QRCodeDataSchema.getData
- Defined in schemas/ExportMnemonicDataSchema.ts:46
The getData() method returns an object that will be stored in the data field of the underlying QR Code JSON content.

Parameters
- qr: MnemonicQR
Returns any

toObject

toObject(qr: QRCode): any

Inherited from QRCodeDataSchema.toObject
- Defined in QRCodeDataSchema.ts:54
The toObject() method returns a JSON object with required fields.

Parameters
- qr: QRCode
Returns any

Static parse

parse(json: string, password?: string): MnemonicQR

- Defined in schemas/ExportMnemonicDataSchema.ts:73
Parse a JSON QR code content into a MnemonicQR object.

throws
{Error} On empty json given.

throws
{Error} On missing type field value.

throws
{Error} On unrecognized QR code type field value.

throws
{Error} On invalid password.

Parameters
- json: string
- Optional password: string
  
  Optional password
Returns MnemonicQR

Generated using TypeDoc