handleWebSocket

handleWebSocket<TEnv, TDurableObjectRpc, CFHostMetada>(request, env, _ctx, options): Promise<Response>

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

Handles /websocket endpoint.

Type Parameters

TEnv

TEnv extends Env = Env

TDurableObjectRpc

TDurableObjectRpc extends undefined | DurableObjectBranded = undefined

CFHostMetada

CFHostMetada = unknown

Parameters

request

Request<CFHostMetada>

env

TEnv

_ctx

ExecutionContext

options

durableObject?

{ name?: ExtractDurableObjectKeys<TEnv>; }

durableObject.name?

ExtractDurableObjectKeys<TEnv>

Needs to match the binding name from the wrangler config

Default

'WEBSOCKET_SERVER'

headers?

HeadersInit

validatePayload?

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

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) => {
    if (request.url.endsWith('/websocket')) {
      return handleWebSocket(request, env, ctx, { headers: {}, validatePayload })
    }

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

Throws

If the payload is invalid