Give every workspace a README describing what it does, its entry points,
and a short usage example, and link them from the root package table.

Frame Tailshare in the root README as the application the libraries exist
to be composed into, with the other apps as development and testing
surfaces. Its own README records what works today and what the open
issues intend for it.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

2026-08-14 23:51:59 +00:00

src

feat: extract generic state transfer package

2026-07-25 17:31:13 +00:00

package.json

feat: extract generic state transfer package

2026-07-25 17:31:13 +00:00

README.md

docs: add per-package READMEs and position Tailshare as the flagship app

2026-08-14 23:51:59 +00:00

tsconfig.json

feat: extract generic state transfer package

2026-07-25 17:31:13 +00:00

tsconfig.typetest.json

feat: extract generic state transfer package

2026-07-25 17:31:13 +00:00

README.md

@webnet/state-transfer

Generic ownership-transfer contract for handing live objects across worker boundaries.

StateTransferable<T> is a single-method interface: transferState(): Promise<T> extracts the transferable state of an object and leaves the local object unusable afterwards. isStateTransferable is a runtime type guard for detecting the interface on an unknown value. The package has no dependencies and no implementations of its own; it exists so packages that need to move live state (sockets, sessions, worker-owned objects) between a worker and its host can agree on one contract without depending on each other.

Usage

import { isStateTransferable, type StateTransferable } from "@webnet/state-transfer"

class Session implements StateTransferable<{ buffer: ArrayBuffer }> {
  async transferState() {
    return { buffer: new ArrayBuffer(0) }
  }
}

async function handOff(x: unknown) {
  if (isStateTransferable(x)) {
    // x becomes unusable after this call
    return x.transferState()
  }
}

README.md

@webnet/state-transfer

Usage

See also