Class: ApplicationRoute

Defined in: src/types/registry/Routes/AppRouteType.ts:19

Constructors

Constructor

new ApplicationRoute(): ApplicationRoute

Defined in: src/types/registry/Routes/AppRouteType.ts:28

Returns

ApplicationRoute

Methods

addParameter()

addParameter(param: string): this

Defined in: src/types/registry/Routes/AppRouteType.ts:133

Function

Parameters

Parameter	Type
param	string

Returns

this

Name

addParameter()

Description

Adds a route param to the current param set, this can be cleared/reset by route.setRouteParameters().

Default

[]

Example

this.addParameter('type')
@function

---

getApplicationRoute()

getApplicationRoute(): IRoute

Defined in: src/types/registry/Routes/AppRouteType.ts:236

Function

Returns

IRoute

Name

getApplicationRoute()

Description

Gets the Routes's Details.

---

setMethod()

setMethod(method: Methods | "options" | "head" | "put" | "all" | "delete" | "post" | "get"): this

Defined in: src/types/registry/Routes/AppRouteType.ts:148

Function

Parameters

Parameter	Type	Description
method	Methods | "options" | "head" | "put" | "all" | "delete" | "post" | "get"

Returns

this

Name

setMethod()

Description

Set the method of your route.

Default

Methods.ALL // Accepts any request on any method

Example

this.setMethod(Methods.GET)
@function

---

setRequiredHeaders()

setRequiredHeaders(headers: string[]): this

Defined in: src/types/registry/Routes/AppRouteType.ts:195

Function

Parameters

Parameter	Type	Description
headers	string[]

Returns

this

Name

setRequiredHeaders()

Description

Set required headers for your route, this enables a route-specific middleware for managing required headers.

Default

[] // No required headers.

Example

this.setRequiredHeaders(['Authorisation', 'Cookie'])
@function

---

setRouteMiddlewares()

setRouteMiddlewares(middlewares: string[]): this

Defined in: src/types/registry/Routes/AppRouteType.ts:168

Function

Parameters

Parameter	Type	Description
middlewares	string[]

Returns

this

Name

setRouteMiddlewares()

Description

Set the middlewares for your route.

Includes all globally running middlewares by default.

Define these middlewares using your middlewares dir.

Default

[] // No middlewares by default or no middlewares with middlewares running on all routes.

Example

this.setRouteMiddlewares(['authorisationMiddleware'])
@function

---

setRouteName()

setRouteName(route: PathParams): this

Defined in: src/types/registry/Routes/AppRouteType.ts:97

Function

Parameters

Parameter	Type	Description
route	PathParams

Returns

this

Name

setRouteName()

Description

Set the route name.

This works with parameters too, works with anything that can go into the first perameter of a request handler.

Default

// Default route is just the file name

Example

this.setRouteName('/api/astronauts')
@function

---

setRouteParameters()

setRouteParameters(params: string[]): this

Defined in: src/types/registry/Routes/AppRouteType.ts:117

Function

Parameters

Parameter	Type	Description
params	string[]

Returns

this

Name

setRouteParameters()

Description

Set the route parameters.

Adds parameters to a route name. These are parsed into the route name as they would be used in express, e.g:

route/:param1/:param2 from ['param1', 'param2']

Default

[]

Example

this.setRouteParameters(['type', 'somethingelse', 'another thing'])
@function

---

useBasePathOverride()

useBasePathOverride(basePath: string): this

Defined in: src/types/registry/Routes/AppRouteType.ts:211

Function

Parameters

Parameter	Type	Description
basePath	string

Returns

this

Name

useBasePathOverride()

Description

Enable the override for the basePath option in the JovaServer instance config.

Default

null // Use default basePath of '', also means disabled.

Example

this.useBasePathOverride('/api/iss')
@function