SettingsUpdateOptionsOverwrite

The options for {@link Settings#update} when specifying arrayAction as overwrite.

memberof: Settings

Hierarchy

SettingsResetOptions
- SettingsUpdateOptionsOverwrite

Index

Properties

arrayAction
extraContext
guild

Properties

arrayAction

arrayAction: Overwrite | "overwrite"

The array action, in this case overwrite and not supporting arrayIndex.

example

settings.get('words'); // -> ['foo', 'bar']

await settings.update('words', ['hello', 'world'], { arrayAction: 'overwrite' }); settings.get('words'); // -> ['hello', 'world']

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.