Skip to main content

SyncServiceParameters

@webda/offline

Class: SyncServiceParameters

Defined in: packages/offline/src/server/sync.service.ts:44

Parameters of the SyncService

Extends​

  • ServiceParameters

Constructors​

Constructor​

new SyncServiceParameters(): SyncServiceParameters

Returns​

SyncServiceParameters

Inherited from​

ServiceParameters.constructor

Properties​

maxMutations​

maxMutations: number

Defined in: packages/offline/src/server/sync.service.ts:73

Maximum mutations accepted per Sync.Push request (clients batch with pushBatchSize, 100 by default)

Default​

100

maxQueryLength​

maxQueryLength: number

Defined in: packages/offline/src/server/sync.service.ts:63

Maximum length of a scope query

Default​

1024

maxScopes​

maxScopes: number

Defined in: packages/offline/src/server/sync.service.ts:58

Maximum scopes per request

Default​

20

models​

models: string[]

Defined in: packages/offline/src/server/sync.service.ts:48

Models clients can sync; each must implement Syncable

overlap​

overlap: string

Defined in: packages/offline/src/server/sync.service.ts:78

Window re-read by the next pull, covering clock skew between servers

Default​

"5s"

pageSize​

pageSize: number

Defined in: packages/offline/src/server/sync.service.ts:68

Maximum change-log entries or objects returned per Sync.Pull / Sync.Snapshot page

Default​

500

retention​

retention: string

Defined in: packages/offline/src/server/sync.service.ts:53

How long change-log entries are kept; older cursors trigger a resync

Default​

"30d"

type​

type: string

Defined in: packages/core/lib/services/serviceparameters.d.ts:9

Type of the service

Inherited from​

ServiceParameters.type

watchDebounce​

watchDebounce: number

Defined in: packages/offline/src/server/sync.service.ts:83

Debounce of the watch hints, in milliseconds

Default​

250

watchKeepAlive​

watchKeepAlive: number

Defined in: packages/offline/src/server/sync.service.ts:89

Interval of the heartbeats yielded by an idle Sync.Watch, in milliseconds (0 disables them). They let the transport notice a closed client and release the watcher.

Default​

25000

Methods​

load()​

load(params?): this

Defined in: packages/offline/src/server/sync.service.ts:95

Parameters​

params?​

any = {}

the raw parameters

Returns​

this

this

Overrides​

ServiceParameters.load

update()​

update(params, delta): this

Defined in: packages/core/lib/application/parameters.d.ts:21

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/lib/application/parameters.d.ts:27

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