API Reference

ErrorManager

processError(error) => FlexError#

Processes a FlexError

Parameters:

error: FlexError
Error to be processed

Returns:

FlexError
The processed error

Example:

ErrorManager.processError(new FlexError("no connection", {description: "There was no internet connection"})); // creates and processes an error

createAndProcessError(message, content) => FlexError#

Creates and processes a FlexError

Parameters:

message: string
message field of FlexError
content: FlexErrorContents
part of FlexError
- type?: FlexErrorType - Type of the error
- wrappedError?: Error - The original error
- plugin?: FlexError.PluginInfo - Information about the plugin where the error occured (if applicable)
- context?: string - Error context, including theme customizations
- description?: string - Longer and more verbose description of the error than message property, possibly with variable metadata
- severity?: FlexErrorSeverity - Severity level of the error

Returns:

FlexError
An instance of FlexError

Example:

ErrorManager.createAndProcessError( "no connection",  {description: "There was no internet connection", context:"some context"});