***
title: "SettingsStoreService"
generated: true
---------------
The SettingsStoreService provides a flexible settings storage system with support for
scoping, permissions, and validation. It allows plugins and the core system to
store and retrieve configuration data with fine-grained control over access and isolation.
## Usage
Values are automatically scoped according to their field configuration:
*Example*
```ts
// In a service
const userTheme = await this.settingsStoreService.get('dashboard.theme', ctx);
await this.settingsStoreService.set('dashboard.theme', 'dark', ctx);
// Get multiple values
const settings = await this.settingsStoreService.getMany([
'dashboard.theme',
'dashboard.tableFilters'
], ctx);
```
```ts title="Signature"
class SettingsStoreService implements OnModuleInit {
constructor(connection: TransactionalConnection, moduleRef: ModuleRef, configService: ConfigService)
onModuleInit() => ;
register(registration: SettingsStoreRegistration) => void;
get(ctx: RequestContext, key: string) => Promise;
get(key: string, ctx: RequestContext) => Promise;
get(keyOrCtx: string | RequestContext, ctxOrKey: RequestContext | string) => Promise;
getMany(ctx: RequestContext, keys: string[]) => Promise>>;
getMany(keys: string[], ctx: RequestContext) => Promise>>;
getMany(keysOrCtx: string[] | RequestContext, ctxOrKeys: RequestContext | string[]) => Promise>>;
set(ctx: RequestContext, key: string, value: T) => Promise;
set(key: string, value: T, ctx: RequestContext) => Promise;
set(keyOrCtx: string | RequestContext, keyOrValue: string | T, ctxOrValue: RequestContext | T) => Promise;
setMany(ctx: RequestContext, values: Record>) => Promise;
setMany(values: Record>, ctx: RequestContext) => Promise;
setMany(valuesOrCtx: Record> | RequestContext, ctxOrValues: RequestContext | Record>) => Promise;
getFieldDefinition(key: string) => SettingsStoreFieldConfig | undefined;
getAllFieldDefinitions() => Array<{ key: string; config: SettingsStoreFieldConfig }>;
getScopeType(fieldConfig: SettingsStoreFieldConfig) => SettingsStoreScopeType;
validateValue(key: string, value: any, ctx: RequestContext) => Promise;
findOrphanedEntries(options: CleanupOrphanedSettingsStoreEntriesOptions = {}) => Promise;
cleanupOrphanedEntries(options: CleanupOrphanedSettingsStoreEntriesOptions = {}) => Promise;
hasPermission(ctx: RequestContext, key: string) => boolean;
hasReadPermission(ctx: RequestContext, key: string) => boolean;
hasWritePermission(ctx: RequestContext, key: string) => boolean;
isReadonly(key: string) => boolean;
}
```
* Implements: OnModuleInit
### onModuleInit
\
`} />
### register
\SettingsStoreRegistration) => void`} />
Register settings store fields. This is typically called during application
bootstrap when processing the VendureConfig.
### get
\RequestContext, key: string) => Promise`} />
Get a value for the specified key. The value is automatically scoped
according to the field's scope configuration.
### get
\RequestContext) => Promise`} />
### get
\RequestContext, ctxOrKey: RequestContext | string) => Promise`} />
### getMany
\RequestContext, keys: string[]) => PromiseJsonCompatible>>`} />
Get multiple values efficiently. Each key is scoped according to
its individual field configuration.
### getMany
\RequestContext) => PromiseJsonCompatible>>`} />
### getMany
\RequestContext, ctxOrKeys: RequestContext | string[]) => PromiseJsonCompatible>>`} />
### set
\RequestContext, key: string, value: T) => Promise<SetSettingsStoreValueResult>`} />
Set a value for the specified key with structured result feedback.
This version returns detailed information about the success or failure
of the operation instead of throwing errors.
### set
\RequestContext) => Promise<SetSettingsStoreValueResult>`} />
### set
\RequestContext, keyOrValue: string | T, ctxOrValue: RequestContext | T) => Promise<SetSettingsStoreValueResult>`} />
### setMany
\RequestContext, values: RecordJsonCompatible>) => Promise<SetSettingsStoreValueResult[]>`} />
Set multiple values with structured result feedback for each operation.
This method will not throw errors but will return
detailed results for each key-value pair.
### setMany
\JsonCompatible>, ctx: RequestContext) => Promise<SetSettingsStoreValueResult[]>`} />
### setMany
\JsonCompatible> | RequestContext, ctxOrValues: RequestContext | RecordJsonCompatible>) => Promise<SetSettingsStoreValueResult[]>`} />
### getFieldDefinition
\ SettingsStoreFieldConfig | undefined`} />
Get the field configuration for a key.
### getAllFieldDefinitions
\ Array<{ key: string; config: SettingsStoreFieldConfig }>`} since="3.6.0" />
Returns all registered field definitions with their full keys.
### getScopeType
\SettingsStoreFieldConfig) => SettingsStoreScopeType`} since="3.6.0" />
Determines the scope type of a field by comparing its scope function reference
to the pre-built SettingsStoreScopes functions.
### validateValue
\RequestContext) => Promise`} />
Validate a value against its field definition.
### findOrphanedEntries
\CleanupOrphanedSettingsStoreEntriesOptions = {}) => Promise<OrphanedSettingsStoreEntry[]>`} />
Find orphaned settings store entries that no longer have corresponding field definitions.
### cleanupOrphanedEntries
\CleanupOrphanedSettingsStoreEntriesOptions = {}) => Promise<CleanupOrphanedSettingsStoreEntriesResult>`} />
Clean up orphaned settings store entries from the database.
### hasPermission
\RequestContext, key: string) => boolean`} />
Check if the current user has permission to access a field.
This is not called internally in the get and set methods, so should
be used by any methods which are exposing these methods via the GraphQL
APIs.
### hasReadPermission
\RequestContext, key: string) => boolean`} since="3.5.0" />
Check if the current user has permission to read a field.
### hasWritePermission
\RequestContext, key: string) => boolean`} since="3.5.0" />
Check if the current user has permission to write a field.
### isReadonly
\ boolean`} />
Returns true if the settings field has the `readonly: true` configuration.