API.md

AccountRescue

• AccountRescue
  • ~regenerateSecret(remote, local, password) ⇒ Promise.<String>
  • ~renderRescue(options, [macros]) ⇒ Promise.<AccountRescueInfo>
  • ~RenderRescueOptions : Object
  • ~RenderRescueTemplateProperties : Object
  • ~AccountRescueInfo : Object

AccountRescue~regenerateSecret(remote, local, password) ⇒ Promise.<String>

Regenerate secret value from rescue components

Kind: inner method of AccountRescue
Returns: Promise.<String> - A promise that resolves with the original secret value

Param	Type	Description
remote	String	The remote payload
local	String	The local payload, taken from the QR
password	String	The local password, taken from the rescue document

AccountRescue~renderRescue(options, [macros]) ⇒ Promise.<AccountRescueInfo>

Render a rescue document

Kind: inner method of AccountRescue
Returns: Promise.<AccountRescueInfo> - Account rescue data

Param	Type
options	RenderRescueOptions
[macros]	RenderRescueTemplateProperties

AccountRescue~RenderRescueOptions : Object

Kind: inner typedef of AccountRescue
Properties

Name	Type	Description
accountIdentifier	String	The account identification value (ID, username etc.)
accountSecret	String	The secret value to encrypt, which will be made available when consuming the rescue information
output	String	Type of output - either "html" (string) or "pdf" (buffer)

AccountRescue~RenderRescueTemplateProperties : Object

Kind: inner typedef of AccountRescue
Properties

Name	Type	Description
[colour]	String	Set the header background colour
[system]	String	The name of the system
[url]	String	The URL for the user to browse to in the event they want to recover their account

AccountRescue~AccountRescueInfo : Object

Kind: inner typedef of AccountRescue
Properties

Name	Type	Description
data	String | Buffer	Resulting data (PDF/HTML)
remote	String	Remote secret