Interface RecordKitError

Errors produced by RecordKit include user-friendly messages suitable for display in your UI.

See the Logging and Error Handling guide for more information.

interface RecordKitError {
    name: "RecordKitError";
    code: RecordKitErrorCode;
    codeNumber: number;
    message: string;
    debugDescription: string;
}

Properties

name code codeNumber message debugDescription

Properties

name

name: "RecordKitError"

code

code: RecordKitErrorCode

Error code, used for grouping related errors. See RecordKitErrorCode for the full list of codes.

codeNumber

codeNumber: number

Error code number. See RECORDKIT_ERROR_CODE_NUMBERS.

message

message: string

Message describing the problem and possible recovery options, intended to be shown directly to the end-user.

debugDescription

debugDescription: string

Detailed technical description of this error, used in debugging

Settings

Member Visibility

Theme

On This Page

namecodecodeNumbermessagedebugDescription

Generated using TypeDoc