Skip to main content

FireStoreParameters

@webda/gcp

Class: FireStoreParameters

Defined in: gcp/src/services/firestore.service.ts:47

Firebase parameters

Extends​

  • StoreParameters

Constructors​

Constructor​

new FireStoreParameters(): FireStoreParameters

Returns​

FireStoreParameters

Inherited from​

StoreParameters.constructor

Properties​

collection​

collection: string

Defined in: gcp/src/services/firestore.service.ts:51

Collection to use

collections?​

optional collections?: object

Defined in: gcp/src/services/firestore.service.ts:58

Per-model collection overrides. Maps a model identifier (e.g. "Webda/User") to a collection name. When not specified, the first model uses collection and others use their identifier lowercased with "/" replaced by "_".

Index Signature​

[modelIdentifier: string]: string

compoundIndexes?​

optional compoundIndexes?: FireStoreIndex[]

Defined in: gcp/src/services/firestore.service.ts:64

To allow efficient query on several fields

See​

https://firebase.google.com/docs/firestore/query-data/queries

defaultModel?​

optional defaultModel?: boolean

Defined in: core/lib/stores/store.d.ts:218

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

Default​

true

Inherited from​

StoreParameters.defaultModel

forceModel?​

optional forceModel?: boolean

Defined in: core/lib/stores/store.d.ts:224

If set, Store will ignore the __type

Default​

false

Inherited from​

StoreParameters.forceModel

modelAliases?​

optional modelAliases?: object

Defined in: core/lib/stores/store.d.ts:234

Model Aliases to allow easier rename of Model

Index Signature​

[key: string]: string

Inherited from​

StoreParameters.modelAliases

models?​

optional models?: string[]

Defined in: core/lib/stores/store.d.ts:202

Models managed by this Store.

Default​

["Webda/RegistryEntry"]

Inherited from​

StoreParameters.models

noCache?​

optional noCache?: boolean

Defined in: core/lib/stores/store.d.ts:240

Disable default memory cache

Inherited from​

StoreParameters.noCache

slowQueryThreshold​

slowQueryThreshold: number

Defined in: core/lib/stores/store.d.ts:230

Slow query threshold

Default​

30000

Inherited from​

StoreParameters.slowQueryThreshold

strict?​

optional strict?: boolean

Defined in: core/lib/stores/store.d.ts:211

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

Inherited from​

StoreParameters.strict

type​

type: string

Defined in: core/lib/services/serviceparameters.d.ts:8

Type of the service

Inherited from​

StoreParameters.type

Methods​

load()​

load(params?): this

Defined in: gcp/src/services/firestore.service.ts:71

Parameters​

params?​

any = {}

raw parameters

Returns​

this

this

Overrides​

StoreParameters.load

update()​

update(params, delta): this

Defined in: core/lib/services/serviceparameters.d.ts:25

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​

StoreParameters.update

with()​

with(callback): this

Defined in: core/lib/services/serviceparameters.d.ts:31

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​

StoreParameters.with