Class Failure

Readonly code

Readonly description

Readonly type

Static conflict

• conflict(code?, description?): Failure

• Creates a new instance of Failure with type FailureTypes.Conflict from a code and description.

  Parameters

  • Optional code: string = 'General.Conflict'

  • Optional description: string = 'A conflict has occurred.'

  Returns Failure

  {Failure}

  Static

  Memberof

  Failure

Static create

• create(code?, description?): Failure

• Creates a new instance of Failure with type FailureTypes.Default from a code and description.

  Parameters

  • Optional code: string = 'General.Failure'

  • Optional description: string = 'A failure has occurred.'

  Returns Failure

  {Failure}

  Static

  Memberof

  Failure

Static custom

• custom(code, description, type): Failure

• Creates a new instance of Failure from a custom code, description, and type.

  Parameters

  • code: string

  • description: string

  • type: string

  Returns Failure

  {Failure}

  Static

  Memberof

  Failure

Static fromError

• fromError(error): Failure

• Creates a new instance of Failure from an error.

  Parameters

  • error: Error

  Returns Failure

  {Failure}

  Static

  Memberof

  Failure

Static notFound

• notFound(code?, description?): Failure

• Creates a new instance of Failure with type FailureTypes.NotFound from a code and description.

  Parameters

  • Optional code: string = 'General.NotFound'

  • Optional description: string = "A 'Not Found' failure has occurred."

  Returns Failure

  {Failure}

  Static

  Memberof

  Failure

Static unauthorized

• unauthorized(code?, description?): Failure

• Creates a new instance of Failure with type FailureTypes.Unauthorized from a code and description.

  Parameters

  • Optional code: string = 'General.Unauthorized'

  • Optional description: string = "An 'Unauthorized' failure has occurred."

  Returns Failure

  {Failure}

  Static

  Memberof

  Failure

Static unexpected

• unexpected(code?, description?): Failure

• Creates a new instance of Failure with type FailureTypes.Unexpected from a code and description.

  Parameters

  • Optional code: string = 'General.Unexpected'

  • Optional description: string = 'An unexpected failure has occurred.'

  Returns Failure

  {Failure}

  Static

  Memberof

  Failure

Static validation

• validation(code?, description?): Failure

• Creates a new instance of Failure with type FailureTypes.Conflict from a code and description.

  Parameters

  • Optional code: string = 'General.Validation'

  • Optional description: string = 'A validation failure has occurred.'

  Returns Failure

  {Failure}

  Static

  Memberof

  Failure