Skip to main content

IRouter

@webda/core

Interface: IRouter

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

Methods​

addAlias()​

addAlias(url, def): void

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

Add a route alias dynamically

Parameters​

url​

string

def​

string | RouteAliasDefinition

Returns​

void

discoverFilters()​

discoverFilters(services): void

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

Auto-discover services with request-filter and cors-filter capabilities

Parameters​

services​

Iterable<{ getCapabilities(): Record<string, any>; }>

Returns​

void

discoverRoutes()​

discoverRoutes(services): void

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

Auto-discover routes declared via @Route on each service and register them

Parameters​

services​

Iterable<any>

Returns​

void

execute()​

execute(context): Promise<void>

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

Parameters​

context​

IWebContext

Returns​

Promise<void>

exportOpenAPI()​

exportOpenAPI(arg0): any

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

Add to context information and executor based on the http context

Parameters​

arg0​

boolean

Returns​

any

getAliases()​

getAliases(): Record<string, RouteAliasDefinition>

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

Return all registered route aliases

Returns​

Record<string, RouteAliasDefinition>

registerCORSFilter()​

registerCORSFilter(filter): any

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

Parameters​

filter​

CORSFilter

Returns​

any

registerModelUrl()​

registerModelUrl(arg0, prefix): unknown

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

Parameters​

arg0​

any

prefix​

string

Returns​

unknown

registerRequestFilter()​

registerRequestFilter(filter): any

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

Parameters​

filter​

RequestFilter

Returns​

any

removeAlias()​

removeAlias(url): void

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

Remove a route alias dynamically

Parameters​

url​

string

Returns​

void

resolveAlias()​

resolveAlias(ctx, method, url): object

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

Resolve an incoming URL against route aliases

Parameters​

ctx​

IWebContext

method​

HttpMethodType

url​

string

Returns​

object

alias​

alias: string

mode​

mode: RouteAliasMode

redirectCode?​

optional redirectCode?: number

url​

url: string