Skip to main content

StoreParameters

@webda/core

Class: StoreParameters

Defined in: packages/core/src/stores/store.ts:226

Internal

Store parameter

— Store configuration schema. Authored in webda.config/deployment files; not consumed by app code directly.

Extends​

Extended by​

Constructors​

Constructor​

new StoreParameters(): StoreParameters

Returns​

StoreParameters

Inherited from​

ServiceParameters.constructor

Properties​

defaultModel?​

optional defaultModel?: boolean

Defined in: packages/core/src/stores/store.ts:249

When __type model not found, use the model If strict is setup this parameter is not used

Default​

true

forceModel?​

optional forceModel?: boolean

Defined in: packages/core/src/stores/store.ts:255

If set, Store will ignore the __type

Default​

false

modelAliases?​

optional modelAliases?: object

Defined in: packages/core/src/stores/store.ts:265

Model Aliases to allow easier rename of Model

Index Signature​

[key: string]: string

models?​

optional models?: string[]

Defined in: packages/core/src/stores/store.ts:232

Models managed by this Store.

Default​

["Webda/RegistryEntry"]

noCache?​

optional noCache?: boolean

Defined in: packages/core/src/stores/store.ts:269

Disable default memory cache

slowQueryThreshold​

slowQueryThreshold: number

Defined in: packages/core/src/stores/store.ts:261

Slow query threshold

Default​

30000

strict?​

optional strict?: boolean

Defined in: packages/core/src/stores/store.ts:242

Allow to load object that does not have the type data

If set to true, then the Store will only managed the defined _model and no model extending this one

Default​

false

type​

type: string

Defined in: packages/core/src/services/serviceparameters.ts:10

Type of the service

Inherited from​

ServiceParameters.type

Methods​

load()​

load(params): StoreParameters

Defined in: packages/core/src/stores/store.ts:276

Load store parameters with defaults for model type, strict mode, and aliases

Parameters​

params​

any

the service parameters

Returns​

StoreParameters

the result

Overrides​

ServiceParameters.load

update()​

update(params?, delta): this

Defined in: packages/core/src/services/serviceparameters.ts:35

Update parameters and call watchers if a parameter was changed

Parameters​

params?​

any = {}

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ServiceParameters.update

with()​

with(callback): this

Defined in: packages/core/src/services/serviceparameters.ts:65

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ServiceParameters.with