@ubstream/ubstream-node-client-sdk / Exports / IPublicHttpDiagnose

Interface: IPublicHttpDiagnose

Object representing diagnose of an operation. All methods can return diagnose(s). A diagnose describes the result of an operation.

Table of contents

Properties

• $code
• $detail
• $message
• $severity
• $title

Properties

$code

• Optional $code: string | number

The http code of the diagnose.

$detail

• Optional $detail: string

The detail of the diagnose which give more information concerning the diagnose.

$message

• $message: string

The message of the diagnose.

$severity

• $severity: PublicHttpDiagnoseSeverity

The severity of a diagnose. ('error' | 'warning' | 'info' | 'success')

• error : Means that an error occurred during the operation.
• warning : Represents a warning. Means no critic error occurred.
• info : Means that the diagnose contains information concerning the operation.
• success : Means that the operation went well.

$title

• Optional $title: string

The title of the diagnose.