Class Request

Hierarchy

Request

Constructors

constructor

new Request(): Request
Returns Request

Properties

`Static` Error

Error: typeof RequestError = RequestError

`Static` Method

Method: typeof RequestMethod = RequestMethod

`Static` ParamType

ParamType: typeof RequestParamValueType = RequestParamValueType

`Static` Status

Status: typeof RequestStatus = RequestStatus

`Static` Type

Type: typeof RequestType = RequestType

Methods

`Static` Body

Body(target: any, propertyKey?: string, paramIndex?: number): void
Deprecated
Use

Request Body
or @Request.body
Parameters
- target: any
- Optional propertyKey: string
- Optional paramIndex: number
Returns void
- Defined in fi/hg/core/Request.ts:519

`Static` Delete

Delete(...config: readonly RequestMapping[]): MethodDecoratorFunction
Deprecated
Use

Delete Mapping
or @Request.deleteMapping
Parameters
- Rest ...config: readonly RequestMapping[]
Returns MethodDecoratorFunction
- Defined in fi/hg/core/Request.ts:576

`Static` Get

Get(...config: readonly RequestMapping[]): MethodDecoratorFunction
Deprecated
Use

Get Mapping
or @Request.getMapping
Parameters
- Rest ...config: readonly RequestMapping[]
Returns MethodDecoratorFunction
- Defined in fi/hg/core/Request.ts:544

`Static` Header

Header(arg1?: any, arg2?: string | boolean | RequestHeaderOptions, arg3?: number): void | ParameterDecoratorFunction
The implementation

Deprecated
Use

Request Header
or @Request.header
Parameters
- Optional arg1: any
- Optional arg2: string | boolean | RequestHeaderOptions
- Optional arg3: number
Returns void | ParameterDecoratorFunction
- Defined in fi/hg/core/Request.ts:315

`Static` Mapping

Mapping(...config: readonly RequestMapping[]): MethodDecoratorFunction
Deprecated
Use

Request Mapping
or @Request.mapping
Parameters
- Rest ...config: readonly RequestMapping[]
Returns MethodDecoratorFunction
- Defined in fi/hg/core/Request.ts:87

`Static` Param

Param(arg1: any, arg2?: string | RequestParamValueType, arg3?: number): void | ParameterDecoratorFunction
Deprecated
Use

Request Param
or @Request.param
Parameters
- arg1: any
- Optional arg2: string | RequestParamValueType
- Optional arg3: number
Returns void | ParameterDecoratorFunction
- Defined in fi/hg/core/Request.ts:188

`Static` PathVariable

PathVariable(arg1?: any, arg2?: string | boolean | RequestPathVariableOptions, arg3?: number): void | ParameterDecoratorFunction
Deprecated
Use

Path Variable
or @Request.pathVariable
Parameters
- Optional arg1: any
- Optional arg2: string | boolean | RequestPathVariableOptions
- Optional arg3: number
Returns void | ParameterDecoratorFunction
- Defined in fi/hg/core/Request.ts:445

`Static` Post

Post(...config: readonly RequestMapping[]): MethodDecoratorFunction
Deprecated
Use

Post Mapping
or @Request.postMapping
Parameters
- Rest ...config: readonly RequestMapping[]
Returns MethodDecoratorFunction
- Defined in fi/hg/core/Request.ts:560

`Static` Put

Put(...config: readonly RequestMapping[]): MethodDecoratorFunction
Deprecated
Use

Put Mapping
or @Request.putMapping
Parameters
- Rest ...config: readonly RequestMapping[]
Returns MethodDecoratorFunction
- Defined in fi/hg/core/Request.ts:592

`Static` `Private` _getRequestController

_getRequestController(target: any, propertyKey: any, paramIndex: any): RequestController
Parameters
- target: any
- propertyKey: any
- paramIndex: any
Returns RequestController
- Defined in fi/hg/core/Request.ts:169

`Static` `Private` _param

_param(target: any, propertyKey: any, paramIndex: any, queryParam: string, paramType: RequestParamValueType): void
Private
The internal implementation
Parameters
- target: any
- propertyKey: any
- paramIndex: any
- queryParam: string
- paramType: RequestParamValueType
Returns void
- Defined in fi/hg/core/Request.ts:149

`Static` `Private` _setMethodHeaderMap

_setMethodHeaderMap(target: any, propertyKey: string, paramIndex: number, defaultValues: DefaultHeaderMapValuesType): void
Private
Private helper
Parameters
- target: any
- propertyKey: string
- paramIndex: number
- defaultValues: DefaultHeaderMapValuesType
Returns void
- Defined in fi/hg/core/Request.ts:290

`Static` `Private` _setPathVariableMap

_setPathVariableMap(target: any, propertyKey: string, paramIndex: number, defaultValues: DefaultPathVariableMapValuesType): void
Parameters
- target: any
- propertyKey: string
- paramIndex: number
- defaultValues: DefaultPathVariableMapValuesType
Returns void
- Defined in fi/hg/core/Request.ts:421

`Static` body

body(target: any, propertyKey?: string, paramIndex?: number): void
Parameters
- target: any
- Optional propertyKey: string
- Optional paramIndex: number
Returns void
- Defined in fi/hg/core/Request.ts:497

`Static` createBadRequestError

createBadRequestError(message: string): RequestError
Parameters
- message: string
Returns RequestError
- Defined in fi/hg/core/Request.ts:597

`Static` createConflictRequestError

createConflictRequestError(message: string): RequestError
Parameters
- message: string
Returns RequestError
- Defined in fi/hg/core/Request.ts:609

`Static` createInternalErrorRequestError

createInternalErrorRequestError(message: string): RequestError
Parameters
- message: string
Returns RequestError
- Defined in fi/hg/core/Request.ts:613

`Static` createMethodNotAllowedRequestError

createMethodNotAllowedRequestError(message: string): RequestError
Parameters
- message: string
Returns RequestError
- Defined in fi/hg/core/Request.ts:605

`Static` createNotFoundRequestError

createNotFoundRequestError(message: string): RequestError
Parameters
- message: string
Returns RequestError
- Defined in fi/hg/core/Request.ts:601

`Static` deleteMapping

deleteMapping(...config: readonly RequestMapping[]): MethodDecoratorFunction
Parameters
- Rest ...config: readonly RequestMapping[]
Returns MethodDecoratorFunction
- Defined in fi/hg/core/Request.ts:567

`Static` getMapping

getMapping(...config: readonly RequestMapping[]): MethodDecoratorFunction
Parameters
- Rest ...config: readonly RequestMapping[]
Returns MethodDecoratorFunction
- Defined in fi/hg/core/Request.ts:535

`Static` header

header(opts?: RequestHeaderListOptions): ParameterDecoratorFunction
Parameters
- Optional opts: RequestHeaderListOptions
Returns ParameterDecoratorFunction
- Defined in fi/hg/core/Request.ts:199
header(headerName: string, opts?: RequestHeaderOptions): ParameterDecoratorFunction
Parameters
- headerName: string
- Optional opts: RequestHeaderOptions
Returns ParameterDecoratorFunction
- Defined in fi/hg/core/Request.ts:203
header(target: any, propertyKey: string, paramIndex: number): void
Parameters
- target: any
- propertyKey: string
- paramIndex: number
Returns void
- Defined in fi/hg/core/Request.ts:208

`Static` mapping

mapping(...config: readonly RequestMapping[]): MethodDecoratorFunction
Parameters
- Rest ...config: readonly RequestMapping[]
Returns MethodDecoratorFunction
- Defined in fi/hg/core/Request.ts:61

`Static` modelAttribute

modelAttribute(attributeName: string): ParameterOrMethodDecoratorFunction
The implementation
Parameters
- attributeName: string
Returns ParameterOrMethodDecoratorFunction
- Defined in fi/hg/core/Request.ts:461

`Static` openAPIDefinition

openAPIDefinition(config: Partial<OpenAPIV3.Document<{}>>): MethodDecoratorFunction
Define OpenAPI document definition
Parameters
- config: Partial<OpenAPIV3.Document<{}>>
Returns MethodDecoratorFunction
- Defined in fi/hg/core/Request.ts:691

`Static` operation

operation(config: Partial<{
    callbacks?: {
        [callback: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.CallbackObject;
    };
    deprecated?: boolean;
    description?: string;
    externalDocs?: OpenAPIV3.ExternalDocumentationObject;
    operationId?: string;
    parameters?: (OpenAPIV3.ReferenceObject | OpenAPIV3.ParameterObject)[];
    requestBody?: OpenAPIV3.ReferenceObject | OpenAPIV3.RequestBodyObject;
    responses: OpenAPIV3.ResponsesObject;
    security?: OpenAPIV3.SecurityRequirementObject[];
    servers?: OpenAPIV3.ServerObject[];
    summary?: string;
    tags?: string[];
}>): MethodDecoratorFunction
Define OpenAPI operation
Parameters
- config: Partial<{
      callbacks?: {
          [callback: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.CallbackObject;
      };
      deprecated?: boolean;
      description?: string;
      externalDocs?: OpenAPIV3.ExternalDocumentationObject;
      operationId?: string;
      parameters?: (OpenAPIV3.ReferenceObject | OpenAPIV3.ParameterObject)[];
      requestBody?: OpenAPIV3.ReferenceObject | OpenAPIV3.RequestBodyObject;
      responses: OpenAPIV3.ResponsesObject;
      security?: OpenAPIV3.SecurityRequirementObject[];
      servers?: OpenAPIV3.ServerObject[];
      summary?: string;
      tags?: string[];
  }>
Returns MethodDecoratorFunction
- Defined in fi/hg/core/Request.ts:666

`Static` optionsMapping

optionsMapping(...config: readonly RequestMapping[]): MethodDecoratorFunction
Parameters
- Rest ...config: readonly RequestMapping[]
Returns MethodDecoratorFunction
- Defined in fi/hg/core/Request.ts:529

`Static` param

param(queryParam: string, paramType?: RequestParamValueType): ParameterDecoratorFunction
The implementation
Parameters
- queryParam: string
- Optional paramType: RequestParamValueType
Returns ParameterDecoratorFunction
- Defined in fi/hg/core/Request.ts:95
param(target: any, propertyKey?: string, paramIndex?: number): void
The implementation
Parameters
- target: any
- Optional propertyKey: string
- Optional paramIndex: number
Returns void
- Defined in fi/hg/core/Request.ts:100

`Static` pathVariable

pathVariable(opts?: RequestPathVariableListOptions): ParameterDecoratorFunction
The implementation
Parameters
- Optional opts: RequestPathVariableListOptions
Returns ParameterDecoratorFunction
- Defined in fi/hg/core/Request.ts:326
pathVariable(headerName: string, opts?: RequestPathVariableOptions): ParameterDecoratorFunction
The implementation
Parameters
- headerName: string
- Optional opts: RequestPathVariableOptions
Returns ParameterDecoratorFunction
- Defined in fi/hg/core/Request.ts:330
pathVariable(target: any, propertyKey: string, paramIndex: number): void
The implementation
Parameters
- target: any
- propertyKey: string
- paramIndex: number
Returns void
- Defined in fi/hg/core/Request.ts:335

`Static` postMapping

postMapping(...config: readonly RequestMapping[]): MethodDecoratorFunction
Parameters
- Rest ...config: readonly RequestMapping[]
Returns MethodDecoratorFunction
- Defined in fi/hg/core/Request.ts:551

`Static` putMapping

putMapping(...config: readonly RequestMapping[]): MethodDecoratorFunction
Parameters
- Rest ...config: readonly RequestMapping[]
Returns MethodDecoratorFunction
- Defined in fi/hg/core/Request.ts:583

`Static` setLogLevel

setLogLevel(level: LogLevel): void
Parameters
- level: LogLevel
Returns void
- Defined in fi/hg/core/Request.ts:43

`Static` throwBadRequestError

throwBadRequestError(message: string): void
Throws
Parameters
- message: string
Returns void
- Defined in fi/hg/core/Request.ts:622

`Static` throwConflictRequestError

throwConflictRequestError(message: string): void
Throws
Parameters
- message: string
Returns void
- Defined in fi/hg/core/Request.ts:649

`Static` throwInternalErrorRequestError

throwInternalErrorRequestError(message: string): void
Throws
Parameters
- message: string
Returns void
- Defined in fi/hg/core/Request.ts:658

`Static` throwMethodNotAllowedRequestError

throwMethodNotAllowedRequestError(message: string): void
Throws
Parameters
- message: string
Returns void
- Defined in fi/hg/core/Request.ts:640

`Static` throwNotFoundRequestError

throwNotFoundRequestError(message: string): void
Throws
Parameters
- message: string
Returns void
- Defined in fi/hg/core/Request.ts:631

Class Request

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Request

Properties

Static Error

Static Method

Static ParamType

Static Status

Static Type

Methods

Static Body

Deprecated

Request Body

Parameters

target: any

Optional propertyKey: string

Optional paramIndex: number

Returns void

Static Delete

Deprecated

Delete Mapping

Parameters

Rest ...config: readonly RequestMapping[]

Returns MethodDecoratorFunction

Static Get

Deprecated

Get Mapping

Parameters

Rest ...config: readonly RequestMapping[]

Returns MethodDecoratorFunction

Static Header

Deprecated

Request Header

Parameters

Optional arg1: any

Optional arg2: string | boolean | RequestHeaderOptions

Optional arg3: number

Returns void | ParameterDecoratorFunction

Static Mapping

Deprecated

Request Mapping

Parameters

Rest ...config: readonly RequestMapping[]

Returns MethodDecoratorFunction

Static Param

Deprecated

Request Param

Parameters

arg1: any

Optional arg2: string | RequestParamValueType

Optional arg3: number

Returns void | ParameterDecoratorFunction

Static PathVariable

Deprecated

Path Variable

Parameters

Optional arg1: any

Optional arg2: string | boolean | RequestPathVariableOptions

Optional arg3: number

Returns void | ParameterDecoratorFunction

Static Post

Deprecated

Post Mapping

Parameters

Rest ...config: readonly RequestMapping[]

Returns MethodDecoratorFunction

Static Put

Deprecated

Put Mapping

Parameters

Rest ...config: readonly RequestMapping[]

Returns MethodDecoratorFunction

Static Private _getRequestController

Parameters

`Static` Error

`Static` Method

`Static` ParamType

`Static` Status

`Static` Type

`Static` Body

`Optional` propertyKey: string

`Optional` paramIndex: number

`Static` Delete

`Rest` ...config: readonly RequestMapping[]

`Static` Get

`Rest` ...config: readonly RequestMapping[]

`Static` Header

`Optional` arg1: any

`Optional` arg2: string | boolean | RequestHeaderOptions

`Optional` arg3: number

`Static` Mapping

`Rest` ...config: readonly RequestMapping[]

`Static` Param

`Optional` arg2: string | RequestParamValueType

`Optional` arg3: number

`Static` PathVariable

`Optional` arg1: any

`Optional` arg2: string | boolean | RequestPathVariableOptions

`Optional` arg3: number

`Static` Post

`Rest` ...config: readonly RequestMapping[]

`Static` Put

`Rest` ...config: readonly RequestMapping[]

`Static` `Private` _getRequestController

`Static` `Private` _param

`Static` `Private` _setMethodHeaderMap

`Static` `Private` _setPathVariableMap

`Static` body

`Optional` propertyKey: string

`Optional` paramIndex: number

`Static` createBadRequestError

`Static` createConflictRequestError

`Static` createInternalErrorRequestError

`Static` createMethodNotAllowedRequestError

`Static` createNotFoundRequestError

`Static` deleteMapping

`Rest` ...config: readonly RequestMapping[]

`Static` getMapping

`Rest` ...config: readonly RequestMapping[]

`Static` header

`Optional` opts: RequestHeaderListOptions

`Optional` opts: RequestHeaderOptions