Skip to content

Reference

Type surface and API contracts. The tutorial is the place to start; this section is for lookup.

PageCovers
BuildermockGroup<E>(), verbs, .data, .prefix, .done, direct body, ctx shorthands
EndpointsEndpointHandle<T> (ListHandle / RecordHandle), dataFile, MockrServer
HandlersVerb specs, req, ctx, responseSchema, scenarios, ctx.forward()
Query paramsjsonParam / jsonArrayParam, factory
WebSocketws({...}), WsEndpoint, WsHandle, hooks, schemas
Middlewarelogger / delay / auth / errorInjection, custom pre / post
ScenariosPer-endpoint presets + named server states
Proxy & forwardPass-through, ctx.forward() mutate-then-return
VerifyresponseSchema + verify / --verify contract-drift checks
RecorderChrome extension, recorder.mocksDir, server file patching
CLI--port / --proxy / --recorder / --verify / --tui
ConfigMockrConfig shape, groups, top-level options

handler() and endpoints() are deprecated — use mockGroup(). See MIGRATION.md.

MIT License