Fluxerly.js
On This Page

MemberChunkError

Class in Errors · JavaScript & TypeScript

A member stream stopped before it could return every batch

The SDK releases local intake and does not automatically resend the request. Already yielded batches are not undone, but unread batches are discarded when intake fails. Metadata contains no requested IDs, member data, correlation nonce or provider payload

class MemberChunkError extends FluxerlyErrorclass MemberChunkError
  extends FluxerlyError

Constructor#

Describe a member-stream failure

Construction sends no request and does not stop or resend a stream

new MemberChunkError(
    options: {
        readonly cause?: unknown
        readonly inputValidation?: InputValidationDetail | null
        readonly reason:
            | "input" | "overflow" | "timeout" | "busy" | "response"
            | "rateLimit" | "notConnected" | "connectionLost"
        readonly retryAfterMs?: number | null
    }
): MemberChunkErrornew MemberChunkError(
  options: {
    readonly cause?: unknown
    readonly inputValidation?:
      | InputValidationDetail
      | null
    readonly reason:
      | "input" | "overflow"
      | "timeout" | "busy"
      | "response" | "rateLimit"
      | "notConnected"
      | "connectionLost"
    readonly retryAfterMs?:
      | number | null
  }
): MemberChunkError

Parameters

options
cause optional

Underlying failure retained as the error's cause

unknown
inputValidation optional

Safe local input detail

It never retains rejected values, credentials, or Fluxer data, and names an unsupported key only when it looks like a field name. Defaults to null

InputValidationDetail | null
reason

Failure category, as described on the reason field

| "input" | "overflow" | "timeout" | "busy" | "response"
| "rateLimit" | "notConnected" | "connectionLost"| "input" | "overflow" | "timeout"
| "busy" | "response" | "rateLimit"
| "notConnected" | "connectionLost"
retryAfterMs optional

Milliseconds to wait before the next member request for rateLimit

Defaults to null

number | null

Properties#

_tag#

Stable expected-failure discriminator

readonly _tag: "MemberChunkError"

inputValidation#

SDK-owned local input detail, or null for non-input failures

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

operation#

Public operation that failed

readonly operation: "members.iterateChunks"

reason#

Failure category

The reason input means invalid selection or settings, and notConnected means the community's shard is absent or not ready. The reason busy means a member stream is already running, shared request capacity is full, or the shard's internal command queue is full. The reason response means malformed or out-of-order batches, and overflow means the unread byte budget was exceeded. The reason timeout means the complete response missed its deadline, and connectionLost means its shard lost the connection. The reason rateLimit means the request is over a Fluxer member request limit. Either Fluxer refused a repeated full-list request, or this client already sent 12 member requests in the last 11 seconds and the SDK did not send this one

readonly reason:
    | "input" | "overflow" | "timeout" | "busy" | "response"
    | "rateLimit" | "notConnected" | "connectionLost"readonly reason:
  | "input" | "overflow"
  | "timeout" | "busy" | "response"
  | "rateLimit" | "notConnected"
  | "connectionLost"

retryAfterMs#

Milliseconds to wait before the next member request for rateLimit, otherwise null

It comes from Fluxer's answer or from the SDK's count of this client's recent requests. The SDK never retries automatically

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

Inherited#

Inherited from FluxerlyError: code, details, hint, toJSON