Class Alias

Index

Constructors

Properties

_method _path action? actionSchema? busboyConfig? fullPath openapi route service? skipped type?

Accessors

Methods

getMethods getPaths isJokerAlias toJSON

Constructors

constructor

new Alias(infos, route): Alias
Parameters
- infos: AliasRouteSchemaOpenApi
- route: Route
Returns Alias
- Defined in src/objects/Alias.ts:41

Properties

`Private` _method

_method: rawHttpMethod = '*'

`Private` _path

_path: string = ''

`Optional` action

action?: string

`Optional` actionSchema

actionSchema?: Omit<ActionSchema, "openapi"> & {
openapi?: ActionOpenApi;
} & {
params?: ValidationSchema;
}

Type declaration

Optional openapi?: ActionOpenApi

Type declaration

Optional params?: ValidationSchema

`Optional` `Readonly` busboyConfig

busboyConfig?: BusboyConfig<unknown>

fullPath

fullPath: string

openapi

openapi: undefined | AliasRouteOpenApi

`Readonly` route

route: Route

`Optional` service

service?: ServiceSchema<ServiceSettingSchema>

skipped

skipped: boolean = false

`Optional` type

type?: string

Accessors

method

get method(): rawHttpMethod
Returns rawHttpMethod
- Defined in src/objects/Alias.ts:20
set method(value): void
Parameters
- value: string
Returns void
- Defined in src/objects/Alias.ts:23

path

get path(): string
Returns string
- Defined in src/objects/Alias.ts:13
set path(value): void
Parameters
- value: string
Returns void
- Defined in src/objects/Alias.ts:16

Methods

getMethods

getMethods(): HTTP_METHODS[]
Returns HTTP_METHODS[]
- Defined in src/objects/Alias.ts:60

getPaths

getPaths(): PathAction[]
Returns PathAction[]
- Defined in src/objects/Alias.ts:74

isJokerAlias

isJokerAlias(): boolean
Returns boolean
- Defined in src/objects/Alias.ts:56

toJSON

toJSON(): AliasRouteSchemaOpenApi
Returns AliasRouteSchemaOpenApi
- Defined in src/objects/Alias.ts:64