Fluxerly.js
On This Page

ConfigurationError

Class in Errors · JavaScript & TypeScript

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

Use field to identify the setting without exposing its rejected value

class ConfigurationError extends FluxerlyErrorclass ConfigurationError
  extends FluxerlyError

Constructor#

new ConfigurationError(
    field:
        | "filter" | "emoji" | "signal" | "command" | "key"
        | "message" | "format" | "instance" | "transport"
        | "overflow" | "prefix" | "next" | "event" | "fetch"
        | "guildId" | "flags" | "stickers" | "channelId"
        | "messages" | "guilds" | "members" | "roles" | "channels"
        | "users" | "directMessages" | "emojis" | "timeoutMs"
        | "concurrency" | "partition" | "debug" | "gateway" | "rest"
        | "cache" | "commands" | "supervisor" | "level"
        | "categories" | "sink" | "dedupe" | "unsafe" | "handler"
        | "task" | "recovery" | "limit" | "schedule" | "identify"
        | "maxMessages" | "idleMs" | "maxBytes" | "maxReactions"
        | "maxPendingMessages" | "maxPendingBytes" | "configuration"
        | "logging" | "onMalformedDispatch" | "childOutput"
        | "token" | "connection" | "sharding" | "totalShards"
        | "shardIds" | "startupTimeoutMs" | "maxStartupAttempts"
        | "eventOptions" | "partitionReady" | "maxPendingChanges"
        | "cacheObserverOptions" | "onError" | "observe" | "uploads"
        | "maxEntries" | "maxAgeMs" | "kind" | "collectorOptions"
        | "onReaction" | "onMessage" | "pages" | "paginateOptions"
        | "removeClicks" | "messageFields" | "help" | "parser"
        | "aliases" | "cooldown" | "assignments" | "childId"
        | "entry" | "restart" | "maxAttempts" | "minDelayMs"
        | "maxDelayMs" | "minimumSpacingMs" | "processes"
        | "shardsPerProcess" | "diagnosticsIntervalMs"
        | "shutdownTimeoutMs" | "drainMs" | "childEnvironment"
        | "args" | "execArgv" | "ignoredEvents" | "presence"
        | "sessions" | "attemptTimeoutMs" | "healthyResetMs"
        | "mediaConcurrency" | "maxQueued" | "queuedJsonMaxBytes"
        | "defaultTimeoutMs" | "webSocket" | "userAgent"
        | "middleware" | "listener" | "delayMs" | "intervalMs"
        | "embedField",
    message: string,
    options?: { readonly cause?: unknown; readonly hint?: string }
): ConfigurationErrornew ConfigurationError(
  field:
    | "filter" | "emoji" | "signal"
    | "command" | "key" | "message"
    | "format" | "instance"
    | "transport" | "overflow"
    | "prefix" | "next" | "event"
    | "fetch" | "guildId" | "flags"
    | "stickers" | "channelId"
    | "messages" | "guilds"
    | "members" | "roles"
    | "channels" | "users"
    | "directMessages" | "emojis"
    | "timeoutMs" | "concurrency"
    | "partition" | "debug"
    | "gateway" | "rest" | "cache"
    | "commands" | "supervisor"
    | "level" | "categories"
    | "sink" | "dedupe" | "unsafe"
    | "handler" | "task"
    | "recovery" | "limit"
    | "schedule" | "identify"
    | "maxMessages" | "idleMs"
    | "maxBytes" | "maxReactions"
    | "maxPendingMessages"
    | "maxPendingBytes"
    | "configuration" | "logging"
    | "onMalformedDispatch"
    | "childOutput" | "token"
    | "connection" | "sharding"
    | "totalShards" | "shardIds"
    | "startupTimeoutMs"
    | "maxStartupAttempts"
    | "eventOptions"
    | "partitionReady"
    | "maxPendingChanges"
    | "cacheObserverOptions"
    | "onError" | "observe"
    | "uploads" | "maxEntries"
    | "maxAgeMs" | "kind"
    | "collectorOptions"
    | "onReaction" | "onMessage"
    | "pages" | "paginateOptions"
    | "removeClicks"
    | "messageFields" | "help"
    | "parser" | "aliases"
    | "cooldown" | "assignments"
    | "childId" | "entry"
    | "restart" | "maxAttempts"
    | "minDelayMs" | "maxDelayMs"
    | "minimumSpacingMs"
    | "processes"
    | "shardsPerProcess"
    | "diagnosticsIntervalMs"
    | "shutdownTimeoutMs"
    | "drainMs"
    | "childEnvironment" | "args"
    | "execArgv" | "ignoredEvents"
    | "presence" | "sessions"
    | "attemptTimeoutMs"
    | "healthyResetMs"
    | "mediaConcurrency"
    | "maxQueued"
    | "queuedJsonMaxBytes"
    | "defaultTimeoutMs"
    | "webSocket" | "userAgent"
    | "middleware" | "listener"
    | "delayMs" | "intervalMs"
    | "embedField",
  message: string,
  options?: {
    readonly cause?: unknown
    readonly hint?: string
  }
): ConfigurationError

Parameters

field

The invalid option or containing object, including unsupported cache keys, without its rejected value

| "filter" | "emoji" | "signal" | "command" | "key" | "message"
| "format" | "instance" | "transport" | "overflow" | "prefix"
| "next" | "event" | "fetch" | "guildId" | "flags" | "stickers"
| "channelId" | "messages" | "guilds" | "members" | "roles"
| "channels" | "users" | "directMessages" | "emojis" | "timeoutMs"
| "concurrency" | "partition" | "debug" | "gateway" | "rest"
| "cache" | "commands" | "supervisor" | "level" | "categories"
| "sink" | "dedupe" | "unsafe" | "handler" | "task" | "recovery"
| "limit" | "schedule" | "identify" | "maxMessages" | "idleMs"
| "maxBytes" | "maxReactions" | "maxPendingMessages"
| "maxPendingBytes" | "configuration" | "logging"
| "onMalformedDispatch" | "childOutput" | "token" | "connection"
| "sharding" | "totalShards" | "shardIds" | "startupTimeoutMs"
| "maxStartupAttempts" | "eventOptions" | "partitionReady"
| "maxPendingChanges" | "cacheObserverOptions" | "onError"
| "observe" | "uploads" | "maxEntries" | "maxAgeMs" | "kind"
| "collectorOptions" | "onReaction" | "onMessage" | "pages"
| "paginateOptions" | "removeClicks" | "messageFields" | "help"
| "parser" | "aliases" | "cooldown" | "assignments" | "childId"
| "entry" | "restart" | "maxAttempts" | "minDelayMs" | "maxDelayMs"
| "minimumSpacingMs" | "processes" | "shardsPerProcess"
| "diagnosticsIntervalMs" | "shutdownTimeoutMs" | "drainMs"
| "childEnvironment" | "args" | "execArgv" | "ignoredEvents"
| "presence" | "sessions" | "attemptTimeoutMs" | "healthyResetMs"
| "mediaConcurrency" | "maxQueued" | "queuedJsonMaxBytes"
| "defaultTimeoutMs" | "webSocket" | "userAgent" | "middleware"
| "listener" | "delayMs" | "intervalMs" | "embedField"| "filter" | "emoji" | "signal"
| "command" | "key" | "message"
| "format" | "instance" | "transport"
| "overflow" | "prefix" | "next"
| "event" | "fetch" | "guildId"
| "flags" | "stickers" | "channelId"
| "messages" | "guilds" | "members"
| "roles" | "channels" | "users"
| "directMessages" | "emojis"
| "timeoutMs" | "concurrency"
| "partition" | "debug" | "gateway"
| "rest" | "cache" | "commands"
| "supervisor" | "level"
| "categories" | "sink" | "dedupe"
| "unsafe" | "handler" | "task"
| "recovery" | "limit" | "schedule"
| "identify" | "maxMessages"
| "idleMs" | "maxBytes"
| "maxReactions"
| "maxPendingMessages"
| "maxPendingBytes" | "configuration"
| "logging" | "onMalformedDispatch"
| "childOutput" | "token"
| "connection" | "sharding"
| "totalShards" | "shardIds"
| "startupTimeoutMs"
| "maxStartupAttempts"
| "eventOptions" | "partitionReady"
| "maxPendingChanges"
| "cacheObserverOptions" | "onError"
| "observe" | "uploads" | "maxEntries"
| "maxAgeMs" | "kind"
| "collectorOptions" | "onReaction"
| "onMessage" | "pages"
| "paginateOptions" | "removeClicks"
| "messageFields" | "help" | "parser"
| "aliases" | "cooldown"
| "assignments" | "childId" | "entry"
| "restart" | "maxAttempts"
| "minDelayMs" | "maxDelayMs"
| "minimumSpacingMs" | "processes"
| "shardsPerProcess"
| "diagnosticsIntervalMs"
| "shutdownTimeoutMs" | "drainMs"
| "childEnvironment" | "args"
| "execArgv" | "ignoredEvents"
| "presence" | "sessions"
| "attemptTimeoutMs"
| "healthyResetMs"
| "mediaConcurrency" | "maxQueued"
| "queuedJsonMaxBytes"
| "defaultTimeoutMs" | "webSocket"
| "userAgent" | "middleware"
| "listener" | "delayMs"
| "intervalMs" | "embedField"
message

Explanation of the accepted setting, without its rejected value

string
options optional

Optional suggested fix and underlying cause

{ readonly cause?: unknown; readonly hint?: string }{
  readonly cause?: unknown
  readonly hint?: string
}

Properties#

_tag#

Discriminator for narrowing a local configuration failure

readonly _tag: "ConfigurationError"

field#

The invalid option or containing object, including unsupported cache keys, without its rejected value

readonly field:
    | "filter" | "emoji" | "signal" | "command" | "key" | "message"
    | "format" | "instance" | "transport" | "overflow" | "prefix"
    | "next" | "event" | "fetch" | "guildId" | "flags" | "stickers"
    | "channelId" | "messages" | "guilds" | "members" | "roles"
    | "channels" | "users" | "directMessages" | "emojis"
    | "timeoutMs" | "concurrency" | "partition" | "debug"
    | "gateway" | "rest" | "cache" | "commands" | "supervisor"
    | "level" | "categories" | "sink" | "dedupe" | "unsafe"
    | "handler" | "task" | "recovery" | "limit" | "schedule"
    | "identify" | "maxMessages" | "idleMs" | "maxBytes"
    | "maxReactions" | "maxPendingMessages" | "maxPendingBytes"
    | "configuration" | "logging" | "onMalformedDispatch"
    | "childOutput" | "token" | "connection" | "sharding"
    | "totalShards" | "shardIds" | "startupTimeoutMs"
    | "maxStartupAttempts" | "eventOptions" | "partitionReady"
    | "maxPendingChanges" | "cacheObserverOptions" | "onError"
    | "observe" | "uploads" | "maxEntries" | "maxAgeMs" | "kind"
    | "collectorOptions" | "onReaction" | "onMessage" | "pages"
    | "paginateOptions" | "removeClicks" | "messageFields" | "help"
    | "parser" | "aliases" | "cooldown" | "assignments" | "childId"
    | "entry" | "restart" | "maxAttempts" | "minDelayMs"
    | "maxDelayMs" | "minimumSpacingMs" | "processes"
    | "shardsPerProcess" | "diagnosticsIntervalMs"
    | "shutdownTimeoutMs" | "drainMs" | "childEnvironment" | "args"
    | "execArgv" | "ignoredEvents" | "presence" | "sessions"
    | "attemptTimeoutMs" | "healthyResetMs" | "mediaConcurrency"
    | "maxQueued" | "queuedJsonMaxBytes" | "defaultTimeoutMs"
    | "webSocket" | "userAgent" | "middleware" | "listener"
    | "delayMs" | "intervalMs" | "embedField"readonly field:
  | "filter" | "emoji" | "signal"
  | "command" | "key" | "message"
  | "format" | "instance"
  | "transport" | "overflow"
  | "prefix" | "next" | "event"
  | "fetch" | "guildId" | "flags"
  | "stickers" | "channelId"
  | "messages" | "guilds"
  | "members" | "roles"
  | "channels" | "users"
  | "directMessages" | "emojis"
  | "timeoutMs" | "concurrency"
  | "partition" | "debug"
  | "gateway" | "rest" | "cache"
  | "commands" | "supervisor"
  | "level" | "categories" | "sink"
  | "dedupe" | "unsafe" | "handler"
  | "task" | "recovery" | "limit"
  | "schedule" | "identify"
  | "maxMessages" | "idleMs"
  | "maxBytes" | "maxReactions"
  | "maxPendingMessages"
  | "maxPendingBytes"
  | "configuration" | "logging"
  | "onMalformedDispatch"
  | "childOutput" | "token"
  | "connection" | "sharding"
  | "totalShards" | "shardIds"
  | "startupTimeoutMs"
  | "maxStartupAttempts"
  | "eventOptions"
  | "partitionReady"
  | "maxPendingChanges"
  | "cacheObserverOptions"
  | "onError" | "observe"
  | "uploads" | "maxEntries"
  | "maxAgeMs" | "kind"
  | "collectorOptions"
  | "onReaction" | "onMessage"
  | "pages" | "paginateOptions"
  | "removeClicks"
  | "messageFields" | "help"
  | "parser" | "aliases"
  | "cooldown" | "assignments"
  | "childId" | "entry" | "restart"
  | "maxAttempts" | "minDelayMs"
  | "maxDelayMs"
  | "minimumSpacingMs"
  | "processes"
  | "shardsPerProcess"
  | "diagnosticsIntervalMs"
  | "shutdownTimeoutMs" | "drainMs"
  | "childEnvironment" | "args"
  | "execArgv" | "ignoredEvents"
  | "presence" | "sessions"
  | "attemptTimeoutMs"
  | "healthyResetMs"
  | "mediaConcurrency"
  | "maxQueued"
  | "queuedJsonMaxBytes"
  | "defaultTimeoutMs"
  | "webSocket" | "userAgent"
  | "middleware" | "listener"
  | "delayMs" | "intervalMs"
  | "embedField"

Inherited#

Inherited from FluxerlyError: code, details, hint, toJSON