SyncBackendOptions
Defined in: packages/@livestore/sync-electric/src/index.ts:108
Properties
Section titled “Properties”endpoint
Section titled “endpoint”endpoint:
string| {ping:string;pull:string;push:string; }
Defined in: packages/@livestore/sync-electric/src/index.ts:117
The endpoint to pull/push events. Pull is a GET request, push is a POST request.
Usually this endpoint is part of your API layer to proxy requests to the Electric server
e.g. to implement auth, rate limiting, etc.
Examples
Section titled “Examples”"/api/electric"{ push: "/api/push-event", pull: "/api/pull-event" }
optionalping:object
Defined in: packages/@livestore/sync-electric/src/index.ts:125
enabled?
Section titled “enabled?”
optionalenabled:boolean
Default
Section titled “Default”truerequestInterval?
Section titled “requestInterval?”
optionalrequestInterval:DurationInput
How often to send ping requests
Default
Section titled “Default”10 secondsrequestTimeout?
Section titled “requestTimeout?”
optionalrequestTimeout:DurationInput
How long to wait for a ping response before timing out
Default
Section titled “Default”10 seconds