SettingsUpdateOptionsNonOverwrite

The options for {@link Settings#update} when not specifying arrayAction as overwrite or leaving it default.

memberof: Settings

Hierarchy

SettingsResetOptions
- SettingsUpdateOptionsNonOverwrite

Index

Properties

arrayAction
arrayIndex
extraContext
guild

Properties

Optional arrayAction

arrayAction: Exclude<ArrayActions, Overwrite> | Exclude<ArrayActionsString, "overwrite">

The array action to take, check ArrayActions for the available actions.

Optional arrayIndex

arrayIndex: number | null

The index to do the array updates at. This is option is ignored when arrayAction is set to overwrite.

Optional extraContext

extraContext: unknown

The extra context to be passed through resolvers and events.

Optional guild

guild: Guild

The guild to use as the context. It's not required when the settings' target can be resolved into a Guild, e.g. a TextChannel, a Role, a GuildMember, or a Guild instance.