PresenceError

Class in Errors · JavaScript & TypeScript

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

The reason input includes invalid values or a community assigned to a shard this client does not own. The reason limit means the member selection exceeds a local count or encoded-byte budget

class PresenceError extends FluxerlyErrorclass PresenceError
  extends FluxerlyError

Constructor#

Describe a rejected presence change

Construction changes no saved presence settings

new PresenceError(
    options: {
        readonly cause?: unknown
        readonly inputValidation?: InputValidationDetail | null
        readonly reason: "input" | "limit"
    }
): PresenceErrornew PresenceError(
  options: {
    readonly cause?: unknown
    readonly inputValidation?:
      | InputValidationDetail
      | null
    readonly reason:
      | "input" | "limit"
  }
): PresenceError

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: Whether local validation failed or the selected members exceeded a local budget
"input" | "limit"

Properties#

`_tag`#

Error tag for identifying PresenceError in a Result

readonly _tag: "PresenceError"

`inputValidation`#

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

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

`reason`#

Whether local validation failed or the selected members exceeded a local budget

readonly reason: "input" | "limit"

Inherited#

Inherited from FluxerlyError: code, details, hint, toJSON