Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MnemonicQR

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • new MnemonicQR(mnemonicPlainText: string, networkType: number, generationHash: string, password?: string): MnemonicQR

  • Construct a Mnemonic Export QR Code out of the MnemonicPassPhrase and Password instances.

    Parameters

    • mnemonicPlainText: string
    • networkType: number
    • generationHash: string
    • Optional password: string

    Returns MnemonicQR

Properties

Optional Readonly base64

base64?: string

Readonly encrypted

encrypted: boolean = false

Readonly generationHash

generationHash: string

Readonly mnemonicPlainText

mnemonicPlainText: string

Readonly networkType

networkType: number

Optional Readonly password

password?: string

Readonly type

type: QRCodeType

The type of the QR Code.

Methods

getCorrectionLevel

  • The getCorrectionLevel() method should return the QR Code correction level.

    Sub-classes may overload this method to provide with a different correction level.

    Returns CorrectionLevel

getSchema

  • The getSchema() method should return an instance of a sub-class of QRCodeDataSchema which describes the QR Code data.

    Returns QRCodeDataSchema

getTypeNumber

  • getTypeNumber(): number

toBase64

  • Generate QRcode image Base64.

    The returned string can be put in the src attribute of a <img /> tag directly in HTML. The produced image will be a PNG.

    Parameters

    Returns Observable<string>

    Return image data in Base64.

toCanvas

toJSON

  • toJSON(): string

  • The toJSON() method should return the JSON representation of the QR Code content.

    Returns string

toObject

toString

Static fromJSON

  • fromJSON(json: string, password?: string): MnemonicQR

  • 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.

    Parameters

    • json: string
    • Optional password: string

      Optional password

    Returns MnemonicQR

Generated using TypeDoc