Type Alias Spool

Readonlyconfig

decorate

• decorate(
      request: Request,
      response: Response,
      options?: DecorateOptions,
  ): Promise<Response>

  adds the envelope headers and the client tag to a response the app produced

  Parameters

  • request: Request
  • response: Response
  • Optionaloptions: DecorateOptions

  Returns Promise<Response>

handle

• handle(
      request: Request,
      next: (request: Request) => Response | Promise<Response>,
  ): Promise<Response>

  answers /.spool/* and the worker script, otherwise calls next and decorates

  Parameters

  • request: Request
  • next: (request: Request) => Response | Promise<Response>

  Returns Promise<Response>

invalidate

• invalidate(
      tags: readonly string[],
      options?: { drop?: readonly string[] },
  ): Promise<number>

  bumps the vector after a write; drop also removes artifacts by id

  Parameters

  • tags: readonly string[]
  • Optionaloptions: { drop?: readonly string[] }

  Returns Promise<number>

partition

• partition(principal: string): Promise<string>

  The Spool-Partition value for a principal. A login or account-switch handler sets it on its own response, since the request it answers still carries the old identity: the worker then swaps its store before any local view can read the old one.

  Parameters

  • principal: string

  Returns Promise<string>

respond

• respond(request: Request): Promise<Response | undefined>

  a Response for /.spool/*, undefined for anything else

  Parameters

  • request: Request

  Returns Promise<Response | undefined>

stub

• stub(): Response

  the /spool-sw.js response

  Returns Response