Interface ErrorEnvelope

Unified error envelope — minimum shape returned by failed sync API calls.

All invoke() rejections satisfy this interface. Older APIs may only carry success + error (back-compat), but newly migrated APIs MUST include code.

interface ErrorEnvelope {
    code?: ApiErrorCode;
    details?: JsonObject;
    error: string;
    success: false;
}

Index

Properties

code? details? error success

Properties

`Optional`code

code?: ApiErrorCode

Machine-readable error code; required on newly migrated APIs.

`Optional`details

details?: JsonObject

Additional context, e.g. { playlist: 3, isLocked: true }.

error

error: string

success

success: false