Plugin API

Plugin API Reference

Plugin

Define a plugin function

type Plugin = (api: PluginAPI) => void

PluginAPI

Set of functions to be used by plugin to extend the host app.

type PluginAPI = {
  addRoute: (route: RouteDefinition) => void
  addGroup: (prefix: string, middlewares?: RouteMiddleware[]) => RouteGroup
  addResponseFilter: (filter: ResponseFilter) => void
  addGlobalMiddleware: (middleware: RouteMiddleware) => void
  useBeforeRoutes: (fn: HookFunction) => void
  useAfterRoutes: (fn: HookFunction) => void
}