Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(jsdoc): Pretty JSON Middleware #2705

Merged
merged 1 commit into from
May 18, 2024
Merged

docs(jsdoc): Pretty JSON Middleware #2705

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions deno_dist/middleware/pretty-json/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,25 @@ type prettyOptions = {
space: number
}

/**
* Pretty JSON middleware for Hono.
*
* @see {@link https://hono.dev/middleware/builtin/pretty-json}
*
* @param {prettyOptions} [options] - The options for the pretty JSON middleware.
* @param {number} [options.space=2] - Number of spaces for indentation.
* @returns {MiddlewareHandler} The middleware handler function.
*
* @example
* ```ts
* const app = new Hono()
*
* app.use(prettyJSON()) // With options: prettyJSON({ space: 4 })
* app.get('/', (c) => {
* return c.json({ message: 'Hono!' })
* })
* ```
*/
export const prettyJSON = (options: prettyOptions = { space: 2 }): MiddlewareHandler => {
return async function prettyJSON(c, next) {
const pretty = c.req.query('pretty') || c.req.query('pretty') === '' ? true : false
Expand Down
19 changes: 19 additions & 0 deletions src/middleware/pretty-json/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,25 @@ type prettyOptions = {
space: number
}

/**
* Pretty JSON middleware for Hono.
*
* @see {@link https://hono.dev/middleware/builtin/pretty-json}
*
* @param {prettyOptions} [options] - The options for the pretty JSON middleware.
* @param {number} [options.space=2] - Number of spaces for indentation.
* @returns {MiddlewareHandler} The middleware handler function.
*
* @example
* ```ts
* const app = new Hono()
*
* app.use(prettyJSON()) // With options: prettyJSON({ space: 4 })
* app.get('/', (c) => {
* return c.json({ message: 'Hono!' })
* })
* ```
*/
export const prettyJSON = (options: prettyOptions = { space: 2 }): MiddlewareHandler => {
return async function prettyJSON(c, next) {
const pretty = c.req.query('pretty') || c.req.query('pretty') === '' ? true : false
Expand Down