Fluxerly.js
On This Page

UserOperationError

Class in Errors · JavaScript & TypeScript

Expected failure from account reads or private-conversation operations

Inspect operation to identify the failed step and outcome before repeating a write. Metadata excludes private input values and upstream bodies. Default API methods return this error in an Err, while Effect methods fail in the typed error channel

class UserOperationError extends FluxerlyErrorclass UserOperationError
  extends FluxerlyError

Constructor#

Create the failure from its operation, reason and outcome, with optional status, retry wait, API detail, input detail and cause

new UserOperationError(
    options: OperationErrorOptions<UserOperation>
): UserOperationErrornew UserOperationError(
  options: OperationErrorOptions<
    UserOperation
  >
): UserOperationError

Parameters

options
OperationErrorOptions<UserOperation>

Properties#

_tag#

Stable failure discriminator

readonly _tag: "UserOperationError"

apiError#

Safe classification of why Fluxer rejected the request, or null when the response could not be classified

readonly apiError: ApiErrorDetail | nullreadonly apiError:
  | ApiErrorDetail | null

inputValidation#

Safe explanation of the locally invalid property, or null when no input problem could be identified

readonly inputValidation: InputValidationDetail | nullreadonly inputValidation:
  | InputValidationDetail | null

operation#

Requested operation

readonly operation: UserOperation

outcome#

Whether the request may have reached Fluxer, described by OperationOutcome

Reconcile an unknown group edit, close or recipient removal before repeating it

readonly outcome: OperationOutcome

reason#

Failure category, described by OperationReason

readonly reason: OperationReason

retryAfterMs#

Fluxer's retry delay in milliseconds when available

readonly retryAfterMs: number | nullreadonly retryAfterMs:
  | number | null

status#

HTTP status when received

readonly status: number | null

Inherited#

Inherited from FluxerlyError: code, details, hint, toJSON