API Docs for: 0.8.0
Show:

ErrorFormatters Class

Defined in: include/error/formatters/error_formatters.js:29
Module: Database

Provides functions and mechanisms to serialize errors

Constructor

ErrorFormatters

()

Defined in include/error/formatters/error_formatters.js:29

Item Index

Methods

Properties

Methods

convertToObject

(
  • params
)
Object private static

Defined in include/error/formatters/error_formatters.js:46

Converts an error to a plain object that can be serialized

Parameters:

  • params Object

Returns:

Object:

formatForMime

(
  • params
  • cb
)
static

Defined in include/error/formatters/error_formatters.js:216

Formats an error for the provided MIME type

Parameters:

  • params Object
    • mime String

      The MIME type of the format to render

    • error Error

      The error to be rendered

    • [request] Request optional
    • [localization] Localization optional
  • cb Function

get

(
  • mime
)
Function static

Defined in include/error/formatters/error_formatters.js:258

Retrieves the formatter for the specified MIME type

Parameters:

  • mime String

Returns:

Function:

formatter for the specified MIME. 'undefined' if does not exist.

html

(
  • params
  • cb
)
static

Defined in include/error/formatters/error_formatters.js:77

Serializes an error as JSON

Parameters:

  • params Object
    • mime String

      The MIME type of the format to render

    • error Error

      The error to be rendered

    • [request] Request optional
    • [localization] Localization optional
  • cb Function

html

(
  • params
  • cb
)
static

Defined in include/error/formatters/error_formatters.js:95

Serializes an error as HTML

Parameters:

  • params Object
    • mime String

      The MIME type of the format to render

    • error Error

      The error to be rendered

    • [request] Request optional
    • [localization] Localization optional
  • cb Function

html

(
  • params
  • cb
)
static

Defined in include/error/formatters/error_formatters.js:157

Serializes an error as XML

Parameters:

  • params Object
    • mime String

      The MIME type of the format to render

    • error Error

      The error to be rendered

    • [request] Request optional
    • [localization] Localization optional
  • cb Function

register

(
  • mime
  • A
)
Boolean static

Defined in include/error/formatters/error_formatters.js:174

Registers a function to be mapped to a given MIME type. The function will be expected to serialize any given Error to the format specified by the MIME type

Parameters:

  • mime String

    The mime type to register the provider for

  • A Function

    function that takes two parameters. The first is an object that provides the error and the second parameter is the callback.

Returns:

Boolean:

TRUE when the provider was registered, FALSE if not

unregister

(
  • mime
)
Boolean static

Defined in include/error/formatters/error_formatters.js:193

Unregisters the provider for the given MIME type. If a default MIME type is specified the current formatter will be unregistered and set to the default implementation

Parameters:

  • mime String

    The MIME type to unregister

Returns:

Boolean:

TRUE when the provider was found and unregistered, FALSE if not

Properties

ASC

Integer private static

Defined in include/dao/indices.js:19

Ascending index value

DEFAULT_MIME

String private static

Defined in include/error/formatters/error_formatters.js:36

The fallback MIME type

DEFAULTS

Object private static

Defined in include/error/formatters/error_formatters.js:270

Contains the default mapping of MIME type to function that will serialize the error to that format

DESC

Integer private static

Defined in include/dao/indices.js:29

Descending index value

failedControllerPaths

Object private static

Defined in include/error/formatters/error_formatters.js:69

MIME_MAP

Object private static

Defined in include/error/formatters/error_formatters.js:286

Contains the mapping of MIME type to function that will serialize the error to that format