Errors

Re-Exports#

Declared in JavaScript & TypeScript and documented there. Import them from @neontechspace/fluxerly/effect as well

describeError#

Describe any error as readable multi-line text: Its name, SDK code, message, suggested fix, safe details and cause chain

errors#

Error helpers that classify and match errors through apiCode, isNotFound, isRetryable, retryAfterMs, outcome and match

ApplicationError#

An application callback invoked by the SDK failed, threw or rejected

AssetUrlError#

The SDK could not make an asset URL from the supplied input

AttachmentDownloadError#

Expected bounded attachment-download failure, without a URL, response body or credential

AttachmentRefreshError#

The SDK could not refresh one ordered batch of attachment URL strings

AuthenticationError#

Fluxer rejected the bot token during connection startup or recovery

BotApplicationOperationError#

The SDK could not read the current bot application

ChannelOperationError#

Expected failure when reading or changing community channels, threads and forum tags

ClientBusyError#

A competing connection operation already owns the client, so this call did not take ownership

ClientClosedError#

The client is permanently closing or closed, so reconnecting requires a new client

CollectorError#

Expected collector failure, separate from results that stop at the count, deadline, idle deadline or explicit stop

ConfigurationError#

A client setting or operation option is invalid before the requested work starts

ConnectionError#

Instance discovery or the gateway connection failed

ConnectionTimeoutError#

Gateway startup or explicit instance discovery exceeded its time budget

CountOperationError#

A fresh gateway-count call could not return its complete result

CriticalWorkerStoppedError#

One of the bot's event or command subscriptions ended while its client was still running

EventOverflowError#

An event subscription stopped because unread events exceeded its count or byte limit

EventReadBusyError#

A second next call tried to read while the same default API pull subscription already had a pending read

EventWaitError#

A filtered event wait ended without a match or could not use its synchronous filter

FluxerlyError#

Base class for every error the SDK returns, throws or reports, in both entry points

GatewaySendError#

Why gateway.send did not hand a command to the shard's connection

GuildOperationError#

Expected failure from guild, member, role and related resource operations

HelperError#

A helper could not use its input

MemberChunkError#

A member stream stopped before it could return every batch

MessageCleanupError#

A cleanup preview or deletion failed, with selected IDs and batch progress where available

MessageError#

A send, reply or forward ended without confirming that Fluxer created the message

MessageOperationError#

A message lookup, read or change failed

OAuthOperationError#

An OAuth call failed an input check, reached a local capacity limit, or failed during its request or response

PaginationError#

Reading multiple pages failed because of invalid settings, a page limit, a stalled cursor or search readiness

PresenceError#

The SDK rejected a status update or member-presence selection before changing its saved settings

RateLimitError#

Discovery HTTP or the gateway imposed a connection rate limit

RestRequestError#

Expected failure of client.rest.request

ShardConnectionError#

A configured gateway shard failed startup or permanently lost its established connection

SupervisorChildError#

Child-helper failure because the parent's message channel is unavailable or carries invalid coordination data

SupervisorError#

Parent-process lifecycle failure, not the child's original client or configuration error

UserOperationError#

Expected failure from account reads or private-conversation operations

WebhookOperationError#

An expected failure while managing a webhook or one of its messages

ApiErrorDetail#

Safe details about a Fluxer API rejection, available in an operation error's apiError field

ApiValidationErrorDetail#

A validation error reported by Fluxer, with a fixed SDK explanation

DescribeErrorOptions#

Settings for describeError

ErrorTools#

Helpers for inspecting SDK errors in either entry point

FluxerlyErrorJson#

The JSON form of an SDK error, produced by toJSON

FluxerlyErrorOptions#

Settings shared by SDK error constructors

InputValidationDetail#

Describes why the SDK rejected an input without keeping the rejected value

MessageCleanupFailureMetadata#

Expected batch failure details included in a failed progress notification

OperationErrorOptions#

Constructor settings shared by resource operation errors, such as GuildOperationError and MessageOperationError

ApiErrorCode#

Stable SDK category of a recognized Fluxer API rejection, read from ApiErrorDetail.code

ApiProviderCode#

Exact Fluxer server code that the SDK recognizes, read from ApiErrorDetail.providerCode

ApiValidationCode#

Exact Fluxer validation code that the SDK recognizes, read from ApiValidationErrorDetail.providerCode

AttachmentDownloadFailure#

Expected attachment-download failures shared by both entry points

AttachmentRefreshFailure#

Expected attachment URL refresh failures shared by both entry points

AttachmentRefreshOperation#

Attachment URL refresh operation identified by safe failure metadata

BotApplicationOperation#

Operation name included in application-read failures

BotApplicationOperationFailure#

Expected application-read failures in both APIs

ChannelOperation#

The channel or thread action named in an expected failure or SdkDefect

ChannelOperationFailure#

Native interruption is outside this union, with default API methods additionally returning CancelledError

CollectorFailure#

Expected terminal failures shared by both API styles

ConnectError#

Expected connect and run failures, with default API methods adding CancelledError to their result union

ConnectionFailure#

Expected startup or terminal connection failures, excluding cancellation and SDK defects

CountOperation#

The guild or channel count request named in an error

CountOperationFailure#

Expected fresh-count failure

ErrorMatchHandlers#

Handlers for errors.match, keyed by each possible error's _tag, plus an optional _ fallback

EventReadError#

Expected subscription-read failures from queue overflow or a competing pending read

EventWaitFailure#

Expected filtered event-wait failures, including invalid options, client closure, queue overflow, deadline expiry or a failed filter

GatewaySendFailure#

Expected gateway.send failures in both APIs

GuildOperation#

The guild or related-resource action named in an expected failure or SdkDefect

GuildOperationFailure#

Native interruption is outside this union

InputValidationConstraint#

Identifies why the SDK rejected an input before sending a request

InstanceResolveError#

Expected instance-resolution failures, including invalid options, connection trouble, deadline expiry, rate limits and client closure

MemberChunkFailure#

Expected stream failure

MessageCleanupErrorReason#

Expected preview or cleanup failure classification

MessageCleanupFailure#

Expected preview and cleanup errors shared by both entry points

MessageOperationFailure#

Message lookup, management and reaction failures shared by both entry points

NotFoundResource#

Resources that Fluxer reports as missing, accepted by errors.isNotFound

OAuthOperation#

Public OAuth call identified by operation-error metadata

OAuthOperationFailure#

Expected OAuth failures shared by both entry points

Operation#

Identifies the default API call during which an SdkDefect was observed

OperationOutcome#

Whether a request may have reached Fluxer

OperationReason#

Why a remote operation failed

PaginateFailure#

Expected reaction page failures: Invalid pages or options, a failed send, a failed page change, arrow or click removal, an unavailable or lost gateway, an overflowing listener or a failing users check

PaginationOperation#

Operation name included in a PaginationError or default-API SDK defect to identify the traversal

PresenceFailure#

Expected presence-operation failure

RestOperation#

Operation name included in REST request failures

RestRequestFailure#

Expected REST request failures in both APIs

SendError#

Expected message-creation failures shared by both entry points, including permanent client closure

UserOperation#

User/private-conversation operation named by safe failure metadata

UserOperationFailure#

Cancellation in the default API additionally returns CancelledError

WebhookOperation#

Identifies the webhook action that failed, so an error can be associated with the request the application made

WebhookOperationFailure#

Expected failures shared by webhook operations, including requests made after the client closes