Function withResponseMetadata

withResponseMetadata<T extends RouteHandler>(
handler: T,
metadata: RouteResponseMetadata,
): T
Brands a route handler with the success status it answers with, so a documentation generator can read it without importing the plugin that produced it.

The function is branded in place and returned, so identity is preserved and the brand costs no wrapper frame per request. The property is symbol-keyed and non-enumerable, so it is invisible to Object.keys, JSON.stringify and spread, and the handler behaves exactly as it did.
Type Parameters
- T extends RouteHandler
Parameters
- handler: T
  The handler to brand
- metadata: RouteResponseMetadata
  The success status it answers with
Returns T
The same handler reference, branded
Example
```
const handler = withResponseMetadata(
  (ctx) => ctx.response.status(201).json({ created: true }),
  { status: 201 },
);
```
Since
0.7.0
- Defined in packages/common/src/http.ts:1021