Skip to main content

SettingsStoreEntry

SettingsStoreEntry​

@vendure/coresettings-store-entry.entity.ts
v3.4.0

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
class SettingsStoreEntry extends VendureEntity {
    constructor(input?: Partial<SettingsStoreEntry>)
    @Index()
    @Column()
    key: string;
    @Column('json', { nullable: true })
    value: any | null;
    @Index()
    @Column({ type: 'varchar', nullable: true })
    scope: string | null;
}

constructor​

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

key​

property
string

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

value​

property
any | null

The JSON value stored for this setting

scope​

property
string | null

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