Class RouterBuilder

A router builder is next api handler builder that exposes express-like api.

Example (basic usage)

// In next.js /pages/api/[route]
import { RouterBuilder } from 'next-api-handler'
const router = new RouterBuilder().build()
export default router

Example (add RESTful method)

import { RouterBuilder } from 'next-api-handler'
const router = new RouterBuilder().get((req, res) => "RESPONSE")
export default router

Example (add async method)

import { RouterBuilder } from 'next-api-handler'
const handler = new RouterBuilder().get(async (req, res) => "ASYNC RESPONSE")
export default router

Returns

a builder that can build a next.js api handler.

Hierarchy

ExpressLikeRouter
- RouterBuilder

Index

Constructors

constructor

new RouterBuilder(options?: Partial<{
    error: ApiErrorHandler;
    logger: ApiLogger;
    loggerOption: DefaultApiLoggerOption;
    showMessage: boolean;
}>): RouterBuilder
Parameters
- options: Partial<{
      error: ApiErrorHandler;
      logger: ApiLogger;
      loggerOption: DefaultApiLoggerOption;
      showMessage: boolean;
  }> = {}
Returns RouterBuilder
Overrides ExpressLikeRouter.constructor
- Defined in packages/next-api-handler/src/lib/router-builder.ts:47

Properties

`Readonly` connect

connect: (<T, M>(handler: NextApiHandlerWithMiddleware<T, M>) => ExpressLikeRouter) = ...

Type declaration

- <T, M>(handler: NextApiHandlerWithMiddleware<T, M>): ExpressLikeRouter
- Type Parameters
  - T
  - M extends TypedObject<unknown> = TypedObject<unknown>
  Parameters
  - handler: NextApiHandlerWithMiddleware<T, M>
  Returns ExpressLikeRouter

`Readonly` delete

delete: (<T, M>(handler: NextApiHandlerWithMiddleware<T, M>) => ExpressLikeRouter) = ...

Type declaration

- <T, M>(handler: NextApiHandlerWithMiddleware<T, M>): ExpressLikeRouter
- Type Parameters
  - T
  - M extends TypedObject<unknown> = TypedObject<unknown>
  Parameters
  - handler: NextApiHandlerWithMiddleware<T, M>
  Returns ExpressLikeRouter

`Readonly` get

get: (<T, M>(handler: NextApiHandlerWithMiddleware<T, M>) => ExpressLikeRouter) = ...

Type declaration

- <T, M>(handler: NextApiHandlerWithMiddleware<T, M>): ExpressLikeRouter
- Type Parameters
  - T
  - M extends TypedObject<unknown> = TypedObject<unknown>
  Parameters
  - handler: NextApiHandlerWithMiddleware<T, M>
  Returns ExpressLikeRouter

`Readonly` head

head: (<T, M>(handler: NextApiHandlerWithMiddleware<T, M>) => ExpressLikeRouter) = ...

Type declaration

- <T, M>(handler: NextApiHandlerWithMiddleware<T, M>): ExpressLikeRouter
- Type Parameters
  - T
  - M extends TypedObject<unknown> = TypedObject<unknown>
  Parameters
  - handler: NextApiHandlerWithMiddleware<T, M>
  Returns ExpressLikeRouter

`Readonly` inject

inject: AddMiddleware<ExpressLikeRouter> = ...

`Private` `Readonly` logger

logger: ApiLogger

`Protected` `Readonly` middlewareParallelListMap

middlewareParallelListMap: Partial<Record<MiddlewareRouterMethod, NextApiHandlerWithMiddleware<void | TypedObject<unknown>, any>[]>> = {}

`Protected` `Readonly` middlewareQueueMap

middlewareQueueMap: Partial<Record<MiddlewareRouterMethod, NextApiHandlerWithMiddleware<void | TypedObject<unknown>, any>[]>> = {}

`Readonly` options

options: (<T, M>(handler: NextApiHandlerWithMiddleware<T, M>) => ExpressLikeRouter) = ...

Type declaration

- <T, M>(handler: NextApiHandlerWithMiddleware<T, M>): ExpressLikeRouter
- Type Parameters
  - T
  - M extends TypedObject<unknown> = TypedObject<unknown>
  Parameters
  - handler: NextApiHandlerWithMiddleware<T, M>
  Returns ExpressLikeRouter

`Readonly` patch

patch: (<T, M>(handler: NextApiHandlerWithMiddleware<T, M>) => ExpressLikeRouter) = ...

Type declaration

- <T, M>(handler: NextApiHandlerWithMiddleware<T, M>): ExpressLikeRouter
- Type Parameters
  - T
  - M extends TypedObject<unknown> = TypedObject<unknown>
  Parameters
  - handler: NextApiHandlerWithMiddleware<T, M>
  Returns ExpressLikeRouter

`Readonly` post

post: (<T, M>(handler: NextApiHandlerWithMiddleware<T, M>) => ExpressLikeRouter) = ...

Type declaration

- <T, M>(handler: NextApiHandlerWithMiddleware<T, M>): ExpressLikeRouter
- Type Parameters
  - T
  - M extends TypedObject<unknown> = TypedObject<unknown>
  Parameters
  - handler: NextApiHandlerWithMiddleware<T, M>
  Returns ExpressLikeRouter

`Readonly` put

put: (<T, M>(handler: NextApiHandlerWithMiddleware<T, M>) => ExpressLikeRouter) = ...

Type declaration

- <T, M>(handler: NextApiHandlerWithMiddleware<T, M>): ExpressLikeRouter
- Type Parameters
  - T
  - M extends TypedObject<unknown> = TypedObject<unknown>
  Parameters
  - handler: NextApiHandlerWithMiddleware<T, M>
  Returns ExpressLikeRouter

`Protected` `Readonly` routeHandlerMap

routeHandlerMap: Partial<Record<RouterMethod, NextApiHandlerWithMiddleware<unknown, any>>> = {}

`Private` `Readonly` routerOptions

routerOptions: Required<Partial<{
    error: ApiErrorHandler;
    logger: ApiLogger;
    loggerOption: DefaultApiLoggerOption;
    showMessage: boolean;
}>> = ...

`Readonly` trace

trace: (<T, M>(handler: NextApiHandlerWithMiddleware<T, M>) => ExpressLikeRouter) = ...

Type declaration

- <T, M>(handler: NextApiHandlerWithMiddleware<T, M>): ExpressLikeRouter
- Type Parameters
  - T
  - M extends TypedObject<unknown> = TypedObject<unknown>
  Parameters
  - handler: NextApiHandlerWithMiddleware<T, M>
  Returns ExpressLikeRouter

`Readonly` use

use: AddMiddleware<ExpressLikeRouter> = ...

Methods

`Private` applyErrorHandler

applyErrorHandler(options: Partial<{
    error: ApiErrorHandler;
    logger: ApiLogger;
    loggerOption: DefaultApiLoggerOption;
    showMessage: boolean;
}>): void
Parameters
- options: Partial<{
      error: ApiErrorHandler;
      logger: ApiLogger;
      loggerOption: DefaultApiLoggerOption;
      showMessage: boolean;
  }>
Returns void
- Defined in packages/next-api-handler/src/lib/router-builder.ts:104

build

build(): NextApiHandler<any>
Returns NextApiHandler<any>
Overrides ExpressLikeRouter.build
- Defined in packages/next-api-handler/src/lib/router-builder.ts:53

`Private` getMiddlewarePromiseList

getMiddlewarePromiseList(method: MiddlewareRouterMethod, req: NextApiRequestWithMiddleware<TypedObject<unknown>>, res: NextApiResponse<ApiResponse<unknown>>): Promise<void>[]
Parameters
- method: MiddlewareRouterMethod
- req: NextApiRequestWithMiddleware<TypedObject<unknown>>
- res: NextApiResponse<ApiResponse<unknown>>
Returns Promise<void>[]
- Defined in packages/next-api-handler/src/lib/router-builder.ts:137

`Private` resolveMiddlewareListAndQueue

resolveMiddlewareListAndQueue(routerMethod: RouterMethod, req: NextApiRequestWithMiddleware<TypedObject<unknown>>, res: NextApiResponse<ApiResponse<unknown>>): Promise<void>
Parameters
- routerMethod: RouterMethod
- req: NextApiRequestWithMiddleware<TypedObject<unknown>>
- res: NextApiResponse<ApiResponse<unknown>>
Returns Promise<void>
- Defined in packages/next-api-handler/src/lib/router-builder.ts:114

`Private` resolveMiddlewareQueue

resolveMiddlewareQueue(method: MiddlewareRouterMethod, req: NextApiRequestWithMiddleware<TypedObject<unknown>>, res: NextApiResponse<ApiResponse<unknown>>): Promise<void>
Parameters
- method: MiddlewareRouterMethod
- req: NextApiRequestWithMiddleware<TypedObject<unknown>>
- res: NextApiResponse<ApiResponse<unknown>>
Returns Promise<void>
- Defined in packages/next-api-handler/src/lib/router-builder.ts:159

Class RouterBuilder

Example (basic usage)

Example (add RESTful method)

Example (add async method)

Returns

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: Partial<{ error: ApiErrorHandler; logger: ApiLogger; loggerOption: DefaultApiLoggerOption; showMessage: boolean; }> = {}

Returns RouterBuilder

Properties

Readonly connect

Type declaration

Type Parameters

T

M extends TypedObject<unknown> = TypedObject<unknown>

Parameters

handler: NextApiHandlerWithMiddleware<T, M>

Returns ExpressLikeRouter

Readonly delete

Type declaration

Type Parameters

T

M extends TypedObject<unknown> = TypedObject<unknown>

Parameters

handler: NextApiHandlerWithMiddleware<T, M>

Returns ExpressLikeRouter

Readonly get

Type declaration

Type Parameters

T

M extends TypedObject<unknown> = TypedObject<unknown>

Parameters

handler: NextApiHandlerWithMiddleware<T, M>

Returns ExpressLikeRouter

Readonly head

Type declaration

Type Parameters

T

M extends TypedObject<unknown> = TypedObject<unknown>

Parameters

handler: NextApiHandlerWithMiddleware<T, M>

Returns ExpressLikeRouter

Readonly inject

Private Readonly logger

Protected Readonly middlewareParallelListMap

Protected Readonly middlewareQueueMap

Readonly options

Type declaration

Type Parameters

T

M extends TypedObject<unknown> = TypedObject<unknown>

Parameters

handler: NextApiHandlerWithMiddleware<T, M>

Returns ExpressLikeRouter

Readonly patch

Type declaration

Type Parameters

T

M extends TypedObject<unknown> = TypedObject<unknown>

Parameters

handler: NextApiHandlerWithMiddleware<T, M>

Returns ExpressLikeRouter

Readonly post

Type declaration

Type Parameters

T

M extends TypedObject<unknown> = TypedObject<unknown>

Parameters

handler: NextApiHandlerWithMiddleware<T, M>

Returns ExpressLikeRouter

Readonly put

Type declaration

Type Parameters

T

options: Partial<{
error: ApiErrorHandler;
logger: ApiLogger;
loggerOption: DefaultApiLoggerOption;
showMessage: boolean;
}> = {}

`Readonly` connect

`Readonly` delete

`Readonly` get

`Readonly` head

`Readonly` inject

`Private` `Readonly` logger

`Protected` `Readonly` middlewareParallelListMap

`Protected` `Readonly` middlewareQueueMap

`Readonly` options

`Readonly` patch

`Readonly` post

`Readonly` put

`Protected` `Readonly` routeHandlerMap

`Private` `Readonly` routerOptions

`Readonly` trace

`Readonly` use

`Private` applyErrorHandler

options: Partial<{
error: ApiErrorHandler;
logger: ApiLogger;
loggerOption: DefaultApiLoggerOption;
showMessage: boolean;
}>

`Private` getMiddlewarePromiseList

`Private` resolveMiddlewareListAndQueue

`Private` resolveMiddlewareQueue