Functions

This package introduces middleware functions standardization for more elastic approach to development and feature delivery.

Function schema

This example shows all props that are provided for your usage.

async ({ request, context, event, forward, params }: MiddlewareFunctionProps) => {
  // function body
}

Explanation

Prop:  request

Type: NextRequest

That's a user middleware's request passed to function, which can be later updated by functions in chain.

For example in case of authorization processes or custom headers/cookies management this prop can differ from its entry form.

Prop:  context

Type: Map<string, unknown>

This property contains context shared across whole execution chain for every function.

Prop:  event

Type: NextFetchEvent

This property contains event object for serverless functions execution.

Prop:  forward

Type: (response: MiddlewareReturn) => void

The forward function allows you to forward the response from one middleware function to another. This can be useful for chaining middleware functions together and creating more complex middleware logic.

Prop:  params

Type: () => Partial<Record<string, string | string[]>>

This property contains route parameters parsed from the URL path. Just like it's working in Next.js pages/routes/layouts but without awaiting.

// Example URL: /team/123
// Matcher: '/team/:slug'
 
async ({ params }: MiddlewareFunctionProps) => {
  console.log(params().slug); // Output: 123
}