Skip to main content

SettingsStoreEntry

An entity for storing arbitrary settings data with scoped isolation. This is used by the SettingsStore system to provide flexible key-value storage with support for user, channel, and custom scoping.

Signature

constructor

method(input?: Partial<SettingsStoreEntry>) => SettingsStoreEntry

key

propertystring

The settings key, typically in the format 'namespace.fieldName'

value

propertyany | null

The JSON value stored for this setting

scope

propertystring | null

The scope string that isolates this setting (e.g., 'user:123', 'channel:456', '')

Was this chapter helpful?
Report Issue
Edited Feb 10, 2026ยทEdit this page