proto-socket/typescript/README.md

TypeScript Toki Socket

Status: planned

This package implements Toki Socket protocol version 0.1 for TypeScript.

Scope

• Runtime targets: Node.js TCP, Node.js WebSocket, browser-friendly core types.
• Currently in scope: Communicator, BaseClient, TCP/WS client and server helpers, Go cross-language tests.
• Out of scope for this iteration: TLS+TCP, WSS, browser WebSocket transport wrapper.

Proto Generation

Generated bindings live in src/packets/.

cd typescript
PATH="$PWD/node_modules/.bin:$PATH" protoc \
  --proto_path ../proto \
  --es_out src/packets \
  --es_opt target=ts \
  message_common.proto

After generation, run from the repository root:

tools/check_proto_sync.sh

Validation

cd typescript
npx tsc --noEmit
npx vitest run

cd go
go run ./crosstest/go_typescript.go