makeElectricUrl
makeElectricUrl(
__namedParameters):object
Defined in: packages/@livestore/sync-electric/src/make-electric-url.ts:9
This function should be called in a trusted environment (e.g. a proxy server) as it
requires access to senstive information (e.g. apiSecret / sourceSecret).
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”apiSecret?
Section titled “apiSecret?”string
For self-hosted ElectricSQL
electricHost
Section titled “electricHost”string
searchParams
Section titled “searchParams”URLSearchParams
Needed to extract information from the search params which the @livestore/sync-electric
client implementation automatically adds:
handle: the ElectricSQL handlestoreId: the Livestore storeId
sourceId?
Section titled “sourceId?”string
Needed for Electric Cloud
sourceSecret?
Section titled “sourceSecret?”string
Needed for Electric Cloud
Returns
Section titled “Returns”needsInit
Section titled “needsInit”needsInit:
boolean
Whether the Postgres table needs to be created.
payload
Section titled “payload”payload:
undefined|JsonValue
Sync payload provided by the client
storeId
Section titled “storeId”storeId:
string
The Livestore storeId
url:
string
The URL to the ElectricSQL API endpoint with needed search params.