Skip to main content

@webda/gcpReadme | API


Class: FireStoreParameters

Firebase parameters

Extends

  • StoreParameters

Constructors

new FireStoreParameters(params, service)

new FireStoreParameters(params, service): FireStoreParameters

Parameters

params: DeepPartial<FireStoreParameters>

service: Store<CoreModel, StoreParameters, StoreEvents>

Returns

FireStoreParameters

Overrides

StoreParameters.constructor

Source

gcp/src/services/firestore.ts:37

Properties

additionalModels?

additionalModels?: string[]

Additional models

Allow this store to manage other models

Default

[]

Inherited from

StoreParameters.additionalModels

Source

core/lib/stores/store.d.ts:388


asyncDelete

asyncDelete: boolean

async delete

Inherited from

StoreParameters.asyncDelete

Source

core/lib/stores/store.d.ts:392


collection

collection: string

Collection to use

Source

gcp/src/services/firestore.ts:29


compoundIndexes

compoundIndexes: FireStoreIndex[]

To allow efficient query on several fields

See

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

Source

gcp/src/services/firestore.ts:35


defaultModel?

defaultModel?: boolean

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

Default

true

Inherited from

StoreParameters.defaultModel

Source

core/lib/stores/store.d.ts:414


expose?

expose?: StoreExposeParameters

Expose the service to an urls

Deprecated

will probably be removed in 4.0 in favor of Expose annotation

Inherited from

StoreParameters.expose

Source

core/lib/stores/store.d.ts:398


forceModel?

forceModel?: boolean

If set, Store will ignore the __type

Default

false

Inherited from

StoreParameters.forceModel

Source

core/lib/stores/store.d.ts:420


model?

model?: string

Webda model to use within the Store

Default

"Webda/CoreModel"

Inherited from

StoreParameters.model

Source

core/lib/stores/store.d.ts:380


modelAliases?

modelAliases?: Object

Model Aliases to allow easier rename of Model

Index signature

[key: string]: string

Inherited from

StoreParameters.modelAliases

Source

core/lib/stores/store.d.ts:430


noCache?

noCache?: boolean

Disable default memory cache

Inherited from

StoreParameters.noCache

Source

core/lib/stores/store.d.ts:436


openapi?

openapi?: OpenAPIWebdaDefinition

OpenAPI override

Schema Ignore

Inherited from

StoreParameters.openapi

Source

core/lib/services/service.d.ts:104


slowQueryThreshold

slowQueryThreshold: number

Slow query threshold

Default

30000

Inherited from

StoreParameters.slowQueryThreshold

Source

core/lib/stores/store.d.ts:426


strict?

strict?: boolean

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

Source

core/lib/stores/store.d.ts:407


type

type: string

Type of the service

Inherited from

StoreParameters.type

Source

core/lib/services/service.d.ts:95


url?

url?: string

URL on which to serve the content

Inherited from

StoreParameters.url

Source

core/lib/services/service.d.ts:99