Interface RouterOption

Hierarchy

  • RouterOption

Properties

description? ignoreGlobalPrefix? method? middleware? path? requestMethod routerName? summary?

Properties

Optional description

description?: string

router description, for swagger

Deprecated

Optional ignoreGlobalPrefix

ignoreGlobalPrefix?: boolean

ignore global prefix

Optional method

method?: string

which method decorator attached

Optional middleware

middleware?: MiddlewareParamArray

middleware array in router

Optional path

path?: string | RegExp

router path, like "/api"

requestMethod

requestMethod: string

http method, like "get", "post"

Optional routerName

routerName?: string

router alias name

Optional summary

summary?: string

router summary, for swagger

Deprecated

Settings

Member Visibility

Theme

Generated using TypeDoc