Interface: ErrorCatalogEntry
@roomful/core / ErrorCatalogEntry
Interface: ErrorCatalogEntry
Section titled “Interface: ErrorCatalogEntry”Defined in: packages/core/src/error-catalog.ts:6
A catalog entry describing a RoomfulErrorCode: what it means and what to do about it.
Properties
Section titled “Properties”code:
RoomfulErrorCode
Defined in: packages/core/src/error-catalog.ts:8
The error code this entry describes.
description
Section titled “description”description:
string
Defined in: packages/core/src/error-catalog.ts:12
What the error means.
recoverable
Section titled “recoverable”recoverable:
boolean
Defined in: packages/core/src/error-catalog.ts:16
Whether retrying the operation may reasonably succeed.
remediation
Section titled “remediation”remediation:
string
Defined in: packages/core/src/error-catalog.ts:14
Concrete steps to resolve or work around it.
title:
string
Defined in: packages/core/src/error-catalog.ts:10
A short human-readable title.