makeElectricUrl
makeElectricUrl(
__namedParameters):object
Defined in: packages/@livestore/sync-electric/src/index.ts:105
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
__namedParameters
apiSecret?
string
For self-hosted ElectricSQL
electricHost
string
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?
string
Needed for Electric Cloud
sourceSecret?
string
Needed for Electric Cloud
Returns
object
needsInit
needsInit:
boolean
payload
payload:
undefined|JsonValue
storeId
storeId:
string=args.storeId
url
url:
string