handleSyncRequest

handleSyncRequest<TEnv, TDurableObjectRpc, CFHostMetada>(__namedParameters): Promise<Response>

Defined in: packages/@livestore/sync-cf/src/cf-worker/worker.ts:166

Handles /sync endpoint.

Type Parameters

TEnv

TEnv extends Env = Env

TDurableObjectRpc

TDurableObjectRpc extends undefined | DurableObjectBranded = undefined

CFHostMetada

CFHostMetada = unknown

Parameters

__namedParameters

ctx

ExecutionContext

Only there for type-level reasons

env

TEnv

options?

{ durableObject?: { name?: ExtractDurableObjectKeys<TEnv>; }; headers?: HeadersInit; validatePayload?: (payload, context) => void | Promise<void>; } = {}

options.durableObject?

{ name?: ExtractDurableObjectKeys<TEnv>; }

options.durableObject.name?

ExtractDurableObjectKeys<TEnv>

Needs to match the binding name from the wrangler config

Default

'SYNC_BACKEND_DO'

options.headers?

HeadersInit

options.validatePayload?

(payload, context) => void | Promise<void>

request

Request<CFHostMetada>

searchParams

{ payload: undefined | JsonValue; storeId: string; transport: "http" | "ws"; }

searchParams.payload

undefined | JsonValue = ...

searchParams.storeId

string = Schema.String

searchParams.transport

"http" | "ws" = ...

Returns

Promise<Response>

Example

const validatePayload = (payload: Schema.JsonValue | undefined, context: { storeId: string }) => {
  console.log(`Validating connection for store: ${context.storeId}`)
  if (payload?.authToken !== 'insecure-token-change-me') {
    throw new Error('Invalid auth token')
  }
}

export default {
  fetch: async (request, env, ctx) => {
    const requestParamsResult = getSyncRequestSearchParams(request)

    // Is LiveStore sync request
    if (requestParamsResult._tag === 'Some') {
      return handleSyncRequest({
        request,
        searchParams: requestParamsResult.value,
        env,
        ctx,
        options: { headers: {}, validatePayload }
      })
    }

    return new Response('Invalid path', { status: 400 })
  }
}

Throws

If the payload is invalid