docsParity
honojs/hono30,860TypeScript

vs https://hono.dev/docs/

The documentation is generally well-aligned with the code API surface. Most core exports, middleware, and adapters are properly documented. However, there are a few notable gaps and minor inconsistencies, particularly around undocumented exports and SSG plugin hook signatures.

1 high2 medium5 low
Open issue with all findings ↗
12
Files analyzed
115
API symbols
8
Doc pages
43.2s
Analyzed in
23%
API coverage — Poorly documented
26 of 115 exported symbols mentioned in docs
12 source files inspected · claude-haiku-4-5-20251001 · Jun 8, 2026

8 mismatches found

01

SSG Plugin afterGenerateHook signature mismatch

docs/helpers/ssg at https://hono.dev/docs/helpers/ssg

high
In the code
export type AfterGenerateHook = (result: ToSSGResult) => void | Promise<void>
In the docs
afterGenerateHook: (result, fsModule, options) => { ... }

The documentation example shows the afterGenerateHook receiving three parameters (result, fsModule, options), but the actual type definition only accepts one parameter (result). A developer following the docs example would pass incorrect arguments.

Suggested fix
Update the documentation example to remove the fsModule and options parameters from the afterGenerateHook signature, or update the code type definition to match the documented signature if those parameters are actually needed.
02

Undocumented client types and utilities

src/client/index.ts

medium
In the code
export { parseResponse, DetailedError, Fetch, ClientRequest, ClientResponse, ApplyGlobalResponse, PickResponseByStatusCode } from 'hono/client'
In the docs
(not documented)

The code exports several client-related utilities (parseResponse, DetailedError) and types (Fetch, ClientRequest, ClientResponse, ApplyGlobalResponse, PickResponseByStatusCode) that are not mentioned in the documentation. Developers using the hc client may need to use these but have no guidance.

Suggested fix
Add documentation for these client exports, particularly parseResponse and DetailedError, which are utility functions developers might need to use.
03

Undocumented JSX exports from hono/jsx

src/jsx/index.ts

medium
In the code
export { jsx, memo, Fragment, ErrorBoundary, createContext, useContext, useState, useEffect, useRef, useCallback, useReducer, useId, useDebugValue, use, startTransition, useTransition, useDeferredValue, startViewTransition, useViewTransition, useMemo, useLayoutEffect, useInsertionEffect, createRef, forwardRef, useImperativeHandle, useSyncExternalStore, useActionState, useOptimistic, Suspense, Children, DOMAttributes } from 'hono/jsx'
In the docs
(not documented)

The code exports many React-like APIs from hono/jsx (such as useActionState, useOptimistic, startViewTransition, useViewTransition, useLayoutEffect, useInsertionEffect, useSyncExternalStore, useDebugValue, etc.), but these are not individually documented or listed. The JSX guide exists but does not enumerate these specific exported functions.

Suggested fix
Add a section to the JSX documentation listing all exported functions and hooks from hono/jsx with brief descriptions of each.
04

Undocumented validator export

src/validator/index.ts

low
In the code
export { ValidationFunction, InferInput } from 'hono/validator'
In the docs
(not documented)

The code exports ValidationFunction and InferInput types from hono/validator, but the validator documentation does not mention these types. Developers implementing custom validators may need to reference ValidationFunction but have no documentation for it.

Suggested fix
Add documentation for ValidationFunction and InferInput types in the validator section, explaining when and how to use them.
05

Undocumented Bun adapter exports

src/adapter/bun/index.ts

low
In the code
export { bunFileSystemModule, BunWebSocketData, BunWebSocketHandler } from 'hono/bun'
In the docs
(not documented)

The code exports BunWebSocketData, BunWebSocketHandler, and bunFileSystemModule from the Bun adapter, but these types and utilities are not documented. Developers working with WebSockets on Bun may need guidance on these types.

Suggested fix
Add documentation for Bun adapter WebSocket types and the bunFileSystemModule export.
06

Undocumented AWS Lambda adapter exports

src/adapter/aws-lambda/index.ts

low
In the code
export { defaultIsContentTypeBinary, APIGatewayProxyResult, LambdaEvent, ApiGatewayRequestContext, ApiGatewayRequestContextV2, ALBRequestContext, LambdaContext } from 'hono/aws-lambda'
In the docs
(not documented)

The code exports several types and functions related to AWS Lambda (defaultIsContentTypeBinary, APIGatewayProxyResult, LambdaEvent, etc.) but these are not documented. Users trying to customize Lambda deployments may need these exports.

Suggested fix
Add documentation for AWS Lambda adapter exports, particularly the types and defaultIsContentTypeBinary function.
07

Undocumented Cloudflare Pages adapter exports

src/adapter/cloudflare-pages/index.ts

low
In the code
export { EventContext } from 'hono/cloudflare-pages'
In the docs
(not documented)

The code exports EventContext type from the Cloudflare Pages adapter, but this is not documented. The type may be useful for users working with Cloudflare Pages but have no guidance.

Suggested fix
Add documentation for the EventContext type exported from hono/cloudflare-pages.
08

Undocumented Lambda@Edge adapter exports

src/adapter/lambda-edge/index.ts

low
In the code
export { Callback, CloudFrontConfig, CloudFrontRequest, CloudFrontResponse, CloudFrontEdgeEvent } from 'hono/lambda-edge'
In the docs
(not documented)

The code exports several Lambda@Edge-specific types (Callback, CloudFrontConfig, CloudFrontRequest, CloudFrontResponse, CloudFrontEdgeEvent) but these are not documented. Users working with Lambda@Edge may need to reference these types.

Suggested fix
Add documentation for Lambda@Edge types, particularly CloudFrontConfig, CloudFrontRequest, and CloudFrontResponse.