Skip to main content

RouteInfo

@webda/core


Interface: RouteInfo

Defined in: packages/core/src/rest/irest.ts:92

Route Information default information

Properties​

_method?​

optional _method?: string | Function

Defined in: packages/core/src/rest/irest.ts:105

Method name on the executor


_queryCatchAll?​

optional _queryCatchAll?: string

Defined in: packages/core/src/rest/irest.ts:121

Catch all parameter


_queryParams?​

optional _queryParams?: object[]

Defined in: packages/core/src/rest/irest.ts:117

Query parameters to extract

name​

name: string

required​

required: boolean


_uriTemplateParse?​

optional _uriTemplateParse?: object

Defined in: packages/core/src/rest/irest.ts:113

URI Template parser

fromUri​

fromUri: (uri, options?) => any

Parameters​
uri​

string

options?​
strict​

boolean

Returns​

any

varNames​

varNames: any


executor​

executor: string

Defined in: packages/core/src/rest/irest.ts:101

Executor name


hash?​

optional hash?: string

Defined in: packages/core/src/rest/irest.ts:125

Hash


methods​

methods: HttpMethodType[]

Defined in: packages/core/src/rest/irest.ts:97

HTTP Method to expose


model?​

optional model?: Repository

Defined in: packages/core/src/rest/irest.ts:93


openapi?​

optional openapi?: OpenAPIWebdaDefinition

Defined in: packages/core/src/rest/irest.ts:109

OpenAPI definition


override?​

optional override?: boolean

Defined in: packages/core/src/rest/irest.ts:129

Intend to override existing