API reference
GhostEnv
Constructor
new GhostEnv(config: GhostEnvConfig)
| Field | Type | Description |
|---|---|---|
seed | number / int | PRNG seed (default 1) for providers that use rng |
providers | Provider[] / list | Ordered list; first match wins |
chaos | ChaosOptions / dict | Optional latency / simulated failures |
Methods
| Method | TypeScript |
|---|---|
fetch | fetch(input, init?) → Response |
calls | calls(provider?) → CallRecord[] |
wasCalled | wasCalled(provider, partial?) → boolean |
reset | reset() |
snapshot / restore | snapshot() / restore(data) |
Recording shape
Each CallRecord: id, provider, method, url, request body, responseStatus / response_status, response body, durationMs / duration_ms.
On thrown errors before a provider responds, the recorder may store provider: "error".
Exports
Core
GhostEnv,GhostEnvConfig,ProviderWorldState,mulberry32(advanced / tests)
Recording
Recorder,CallRecordexportRecordingJSON,exportRecordingMarkdown,exportHAR
Presets
- Named helpers:
github,stripe,postgres,openai,s3,slack,anthropic - Lower-level:
githubProvider,stripeProvider, … (customname/ composition)
Eval & replay
runEval,defineScenario,Scenario,EvalReportReplayFixture—fromJSON,nextResponse,reset
Types
ChaosOptions—minLatencyMs?,failureRate?(0–1)
ReplayFixture
Replays CallRecord responses in order as synthetic Response objects (JSON content-type). Use for deterministic replays without live providers.