README.md

Examples

• github.example.ts runs three GitHub requests concurrently with random delays, demonstrating that each request claims its matching recorded interaction regardless of execution order.
• openai.example.ts records a real OpenAI chat completion, then replays the LLM response without making another paid request.
• websocket.example.ts connects to two chat rooms and exchanges schema-validated JSON messages over each recorded WebSocket.

The examples use only the public effect-http-recorder package entrypoint. Run them with:

bun run test:examples

The first run writes cassettes to recordings. Later runs replay those cassettes without contacting either service.

Delete and regenerate all example recordings with:

bun run record:examples

This command removes only examples/recordings, then runs all examples against their real services. Commit the regenerated JSON files so CI can replay them.

The GitHub example optionally reads GITHUB_TOKEN. To record with the token from the local GitHub CLI login:

GITHUB_TOKEN="$(gh auth token)" bun run record:examples

The live request is authenticated, but the recorder's secure defaults omit the authorization header from the cassette. Replay does not require the token.

The OpenAI example needs OPENAI_API_KEY only when recording a new cassette:

OPENAI_API_KEY="..." bun run record:examples

The API key is likewise omitted from the cassette, and replay does not consume tokens or require OpenAI credentials.