The tulip.pkg.middleware module exports the middleware package. It enables app-level middleware (as opposed to route-specific middleware) in the order specified in the configuration. This means that requests will go through those middleware handlers in that order.

#Configuration

• array of string|function = the order of the middleware to apply to web requests.

#API Extensions

Registering this package provides the following method and field extensions.

#App(req, res, nxt)

Sets up the __call metamethod on the App's metatable so that it can be used as initial middleware.

Args:

• req: table = the http Request instance
• res: table = the http Response instance
• nxt: function|nil = the function that calls the next middleware

#f = App:lookup_middleware(name)

Returns the middleware registered for that name, or nil if none.

Args:

• name: string = the name for the registered middleware

Returns:

• f: function = the registered middleware

#App:register_middleware(name, mw)

Registers the middleware mw for name. If there is already a registered middleware for name, throws an error.

Args:

• name: string = the name of the middleware
• mw: function = middleware function (or callable table)

#App:resolve_middleware(mws)

Resolves the middleware identified by a string in the array mws to their actual function (or callable table).

Args:

• mws: array of string|function = the defined middleware

#App.middleware: array of string|function

The list of middleware to apply to web requests. When the App is called as initial middleware, it triggers that chain of middleware next, in sequence.

Back to index