nextjs-api-common-middleware

Index

Enumerations

Interfaces

Type aliases

Functions

Type aliases

AuthHandlerOptions

AuthHandlerOptions: EmptyAuthHandlerOptions | BasicAuthHandlerOptions | BearerAuthHandlerOptions | CustomAuthHandlerOptions

BearerAuthHandlerOptions

BearerAuthHandlerOptions: DefaultBearerAuthHandlerOptions | CustomBearerAuthHandlerOptions

CatchHandler

CatchHandler: (req: PossiblyAuthedNextApiRequest, res: NextApiResponse, error: any) => Promise<void> | void

Type declaration

- (req: PossiblyAuthedNextApiRequest, res: NextApiResponse, error: any): Promise<void> | void
- Parameters
  - req: PossiblyAuthedNextApiRequest
  - res: NextApiResponse
  - error: any
  Returns Promise<void> | void

CorsOriginHandler

CorsOriginHandler: (req: PossiblyAuthedNextApiRequest) => Promise<CorsOriginHandlerResult> | CorsOriginHandlerResult

Type declaration

- (req: PossiblyAuthedNextApiRequest): Promise<CorsOriginHandlerResult> | CorsOriginHandlerResult
- Parameters
  - req: PossiblyAuthedNextApiRequest
  Returns Promise<CorsOriginHandlerResult> | CorsOriginHandlerResult

CorsOriginHandlerResult

CorsOriginHandlerResult: string | string[]

OneHttpMethod

OneHttpMethod: keyof typeof HttpMethod

PossiblyAuthedNextApiHandler

PossiblyAuthedNextApiHandler: (req: PossiblyAuthedNextApiRequest, res: NextApiResponse) => Promise<void> | NextApiHandler

Type declaration

- (req: PossiblyAuthedNextApiRequest, res: NextApiResponse): Promise<void> | NextApiHandler
- Parameters
  - req: PossiblyAuthedNextApiRequest
  - res: NextApiResponse
  Returns Promise<void> | NextApiHandler

RestMiddlewareHandlers

RestMiddlewareHandlers: {}

Object key may be of type HttpMethod, value must be of type PossiblyAuthedNextApiHandler | NextApiHandler

example

{
    get: (req, res) => res.send('Hello world'),
    post: (req, res) => res.send(`Hello ${req.body.name || 'world'}`),
}

Type declaration

UserId

UserId: string | number | null | undefined

UserInfo

UserInfo: UserInfoObject | null | undefined

Functions

auth

auth(handler: PossiblyAuthedNextApiHandler, opts?: AuthHandlerOptions): PossiblyAuthedNextApiHandler

- Defined in src/handlers/auth/index.ts:88
Parameters
- handler: PossiblyAuthedNextApiHandler
- Optional opts: AuthHandlerOptions
Returns PossiblyAuthedNextApiHandler

catchHandlerError

catchHandlerError<T>(handler: PossiblyAuthedNextApiHandler, req: PossiblyAuthedNextApiRequest, res: NextApiResponse, opts?: T): Promise<void>

- Defined in src/utils.ts:5
Type parameters
- T: GenericOptions
Parameters
- handler: PossiblyAuthedNextApiHandler
- req: PossiblyAuthedNextApiRequest
- res: NextApiResponse
- Optional opts: T
Returns Promise<void>

chain

chain(middleware: MiddlewareHandler[], handler: PossiblyAuthedNextApiHandler, opts?: MiddlewareOptions): PossiblyAuthedNextApiHandler

- Defined in src/index.ts:17
Parameters
- middleware: MiddlewareHandler[]
- handler: PossiblyAuthedNextApiHandler
- Default value opts: MiddlewareOptions = {}
Returns PossiblyAuthedNextApiHandler

cors

cors(handler: PossiblyAuthedNextApiHandler, opts?: CorsHandlerOptions): (Anonymous function)

- Defined in src/handlers/cors.ts:19
Parameters
- handler: PossiblyAuthedNextApiHandler
- Optional opts: CorsHandlerOptions
Returns (Anonymous function)

createExport

createExport(_options?: MiddlewareOptions): { auth: (Anonymous function); cors: (Anonymous function); error: (Anonymous function); guard: (Anonymous function); rest: any; _: object }

- Defined in src/index.ts:86
Parameters
- Optional _options: MiddlewareOptions
Returns { auth: (Anonymous function); cors: (Anonymous function); error: (Anonymous function); guard: (Anonymous function); rest: any; _: object }
- auth: (Anonymous function)
- cors: (Anonymous function)
- error: (Anonymous function)
- guard: (Anonymous function)
- rest: function
  - rest(handlers: RestMiddlewareHandlers, opts?: Partial<RestHandlerOptions>): PossiblyAuthedNextApiHandler
  - - Defined in src/index.ts:91
    Parameters
    - handlers: RestMiddlewareHandlers
    - Optional opts: Partial<RestHandlerOptions>
    Returns PossiblyAuthedNextApiHandler
- _: object
  - chain: function
    - chain(middleware: MiddlewareHandler[], handler: PossiblyAuthedNextApiHandler, opts?: MiddlewareOptions): PossiblyAuthedNextApiHandler
    - Defined in src/index.ts:98
      Parameters
      - middleware: MiddlewareHandler[]
      - handler: PossiblyAuthedNextApiHandler
      - Optional opts: MiddlewareOptions
      Returns PossiblyAuthedNextApiHandler
  - createExport: function
    - createExport(opts?: MiddlewareOptions)
    - Defined in src/index.ts:103
      Parameters
      - Optional opts: MiddlewareOptions

guard

guard(handler: PossiblyAuthedNextApiHandler, _opts?: GuardHandlerOptions): PossiblyAuthedNextApiHandler

- Defined in src/handlers/guard.ts:24
Parameters
- handler: PossiblyAuthedNextApiHandler
- Optional _opts: GuardHandlerOptions
Returns PossiblyAuthedNextApiHandler

rest

rest(handlers: RestMiddlewareHandlers, opts?: RestHandlerOptions): PossiblyAuthedNextApiHandler

- Defined in src/handlers/rest.ts:32
Parameters
- handlers: RestMiddlewareHandlers
- Optional opts: RestHandlerOptions
Returns PossiblyAuthedNextApiHandler

Index

Enumerations

Interfaces

Type aliases

Functions

Type aliases

AuthHandlerOptions

BearerAuthHandlerOptions

CatchHandler

Type declaration

Parameters

req: PossiblyAuthedNextApiRequest

res: NextApiResponse

error: any

Returns Promise<void> | void

CorsOriginHandler

Type declaration

Parameters

req: PossiblyAuthedNextApiRequest

Returns Promise<CorsOriginHandlerResult> | CorsOriginHandlerResult

CorsOriginHandlerResult

MiddlewareHandler

Type declaration

Parameters

handler: PossiblyAuthedNextApiHandler

Optional opts: any

Returns PossiblyAuthedNextApiHandler

MiddlewareRestHandler

Type declaration

Parameters

handlers: RestMiddlewareHandlers

Optional opts: RestHandlerOptions

Returns PossiblyAuthedNextApiHandler

OneHttpMethod

PossiblyAuthedNextApiHandler

Type declaration

Parameters

req: PossiblyAuthedNextApiRequest

res: NextApiResponse

Returns Promise<void> | NextApiHandler

RestMiddlewareHandlers

Type declaration

UserId

UserInfo

Functions

auth

Parameters

handler: PossiblyAuthedNextApiHandler

Optional opts: AuthHandlerOptions

Returns PossiblyAuthedNextApiHandler

catchHandlerError

Type parameters

T: GenericOptions

Parameters

handler: PossiblyAuthedNextApiHandler

req: PossiblyAuthedNextApiRequest

res: NextApiResponse

Optional opts: T

Returns Promise<void>

chain

Parameters

middleware: MiddlewareHandler[]

handler: PossiblyAuthedNextApiHandler

Default value opts: MiddlewareOptions = {}

Returns PossiblyAuthedNextApiHandler

cors

Parameters

handler: PossiblyAuthedNextApiHandler

Optional opts: CorsHandlerOptions

Returns (Anonymous function)

createExport

Parameters

Optional _options: MiddlewareOptions

Returns { auth: (Anonymous function); cors: (Anonymous function); error: (Anonymous function); guard: (Anonymous function); rest: any; _: object }

auth: (Anonymous function)

cors: (Anonymous function)

error: (Anonymous function)

guard: (Anonymous function)

rest: function

Parameters