Runtime API

mokup/runtime is the core matcher and response executor.

createRuntime

Use cases:

• Build a custom fetch adapter or test harness by calling runtime.handle directly.
• Run Mokup in environments that do not use Hono (SSR, Workers, integration tests).

Demo:

import { createRuntime } from 'mokup/runtime'

const runtime = createRuntime({ manifest })
const result = await runtime.handle({
  method: 'GET',
  path: '/users',
  query: {},
  headers: {},
  body: undefined,
})

Direct usage with CLI bundle

Use the CLI bundle to load a manifest and handler module map in your runtime:

Use cases:

• Run mocks in production runtimes without filesystem access.
• Share a prebuilt bundle across multiple deployments.

Demo:

pnpm

pnpm exec mokup build --dir mock --out .mokup

npm

npm exec mokup build --dir mock --out .mokup

yarn

yarn mokup build --dir mock --out .mokup

bun

bunx mokup build --dir mock --out .mokup

import { createRuntime } from 'mokup/runtime'
import mokupBundle from './.mokup/mokup.bundle.mjs'

const runtime = createRuntime({
  manifest: mokupBundle.manifest,
  moduleMap: mokupBundle.moduleMap,
  moduleBase: mokupBundle.moduleBase,
})

If you are not bundling handlers, you can omit moduleMap and moduleBase.

createRuntimeApp

Build a Hono app from the manifest (useful for Service Worker or custom fetch handlers).

Use cases:

• Build a fetch handler backed by Mokup routes for Workers or Service Workers.
• Integrate with a Hono-compatible runtime without writing adapters.

Demo:

import { createRuntimeApp } from 'mokup/runtime'

const app = await createRuntimeApp({ manifest })
const response = await app.fetch(new Request('http://localhost/api/users'))

Service Worker helper

mokup/runtime also re-exports handle from hono/service-worker.

Use cases:

• Wire a Hono app into the Service Worker fetch event.
• Keep worker glue code minimal while using Mokup routes.

Demo:

import { createRuntimeApp, handle } from 'mokup/runtime'

const app = await createRuntimeApp({ manifest })
globalThis.addEventListener('fetch', handle(app))

RuntimeOptions

Use cases:

• Pass a lazy manifest loader to defer bundle loading.
• Provide moduleMap/moduleBase when your runtime cannot import local files.

export interface RuntimeOptions {
  manifest: Manifest | (() => Promise<Manifest>)
  moduleBase?: string | URL
  moduleMap?: Record<string, Record<string, unknown>>
}

moduleMap is required for Worker-like environments where you cannot import local files directly.

Demo:

import type { RuntimeOptions } from 'mokup/runtime'
import mokupBundle from './.mokup/mokup.bundle.mjs'

const options: RuntimeOptions = {
  manifest: mokupBundle.manifest,
  moduleMap: mokupBundle.moduleMap,
  moduleBase: mokupBundle.moduleBase,
}