Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @midwayjs/decorator

References

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

References

ALL

ALL:

APPLICATION_KEY

APPLICATION_KEY:

ASPECT_KEY

ASPECT_KEY:

All

All:

App

App:

Aspect

Aspect:

Aspect

Aspect:

AspectMetadata

AspectMetadata:

AspectMetadata

AspectMetadata:

Async

Async:

Async

Async:

Autoload

Autoload:

Autoload

Autoload:

Autowire

Autowire:

Autowire

Autowire:

Body

Body:

CLASS_KEY_CONSTRUCTOR

CLASS_KEY_CONSTRUCTOR:

CONFIGURATION_KEY

CONFIGURATION_KEY:

CONFIG_KEY

CONFIG_KEY:

CONTROLLER_KEY

CONTROLLER_KEY:

CommonSchedule

CommonSchedule:

CommonSchedule

CommonSchedule:

Config

Config:

Configuration

Configuration:

Configuration

Configuration:

Consumer

Consumer:

ConsumerMetadata

ConsumerMetadata:

ContentType

ContentType:

Controller

Controller:

ControllerOption

ControllerOption:

DUPLICATED_INJECTABLE_DECORATOR

DUPLICATED_INJECTABLE_DECORATOR:

DUPLICATED_METADATA

DUPLICATED_METADATA:

DecoratorKey

DecoratorKey:

DecoratorManager

DecoratorManager:

Del

Del:

Destroy

Destroy:

Destroy

Destroy:

Dto

Dto:

DubboMethod

DubboMethod:

Emit

Emit:

FUNC_KEY

FUNC_KEY:

FaaSMetadata

FaaSMetadata:

File

File:

Files

Files:

Func

Func:

FuncParams

FuncParams:

GRPCMetadata

GRPCMetadata:

Get

Get:

GetFileStreamOptions

GetFileStreamOptions:

GetFilesStreamOptions

GetFilesStreamOptions:

GrpcMethod

GrpcMethod:

GrpcStreamTypeEnum

GrpcStreamTypeEnum:

HANDLER_KEY

HANDLER_KEY:

HSF

HSF:

HSFMethod

HSFMethod:

HSFOpts

HSFOpts:

HSF_KEY

HSF_KEY:

Handler

Handler:

Head

Head:

Headers

Headers:

HttpCode

HttpCode:

IComponentInfo

IComponentInfo:

IComponentInfo

IComponentInfo:

IManagedInstance

IManagedInstance:

IMethodAspect

IMethodAspect:

IMethodAspect

IMethodAspect:

INJECT_CLASS_KEY_PREFIX

INJECT_CLASS_KEY_PREFIX:

INJECT_TAG

INJECT_TAG:

INVALID_DECORATOR_OPERATION

INVALID_DECORATOR_OPERATION:

Init

Init:

Init

Init:

Inject

Inject:

Inject

Inject:

InjectionConfigurationOptions

InjectionConfigurationOptions:

InjectionConfigurationOptions

InjectionConfigurationOptions:

JoinPoint

JoinPoint:

JoinPoint

JoinPoint:

LIFECYCLE_IDENTIFIER_PREFIX

LIFECYCLE_IDENTIFIER_PREFIX:

LOGGER_KEY

LOGGER_KEY:

Logger

Logger:

MAIN_MODULE_KEY

MAIN_MODULE_KEY:

MODULE_TASK_KEY

MODULE_TASK_KEY:

MODULE_TASK_METADATA

MODULE_TASK_METADATA:

MODULE_TASK_QUEUE_KEY

MODULE_TASK_QUEUE_KEY:

MODULE_TASK_QUEUE_OPTIONS

MODULE_TASK_QUEUE_OPTIONS:

MODULE_TASK_TASK_LOCAL_KEY

MODULE_TASK_TASK_LOCAL_KEY:

MODULE_TASK_TASK_LOCAL_OPTIONS

MODULE_TASK_TASK_LOCAL_OPTIONS:

MSListenerType

MSListenerType:

MSProviderType

MSProviderType:

MS_CONSUMER_KEY

MS_CONSUMER_KEY:

MS_DUBBO_METHOD_KEY

MS_DUBBO_METHOD_KEY:

MS_GRPC_METHOD_KEY

MS_GRPC_METHOD_KEY:

MS_HSF_METHOD_KEY

MS_HSF_METHOD_KEY:

MS_PRODUCER_KEY

MS_PRODUCER_KEY:

MS_PROVIDER_KEY

MS_PROVIDER_KEY:

Metadata

Metadata:

MiddlewareParamArray

MiddlewareParamArray:

MidwayFrameworkType

MidwayFrameworkType:

NAMED_TAG

NAMED_TAG:

OBJ_DEF_CLS

OBJ_DEF_CLS:

ObjectDefinitionOptions

ObjectDefinitionOptions:

ObjectIdentifier

ObjectIdentifier:

OmitDto

OmitDto:

OnConnection

OnConnection:

OnDisConnection

OnDisConnection:

OnMessage

OnMessage:

OnWSConnection

OnWSConnection:

OnWSDisConnection

OnWSDisConnection:

OnWSMessage

OnWSMessage:

Options

Options:

PIPELINE_IDENTIFIER

PIPELINE_IDENTIFIER:

PLUGIN_KEY

PLUGIN_KEY:

PRELOAD_MODULE_KEY

PRELOAD_MODULE_KEY:

PRIORITY_KEY

PRIORITY_KEY:

PRIVATE_META_DATA_KEY

PRIVATE_META_DATA_KEY:

Param

Param:

Patch

Patch:

PickDto

PickDto:

Pipeline

Pipeline:

Pipeline

Pipeline:

Plugin

Plugin:

Post

Post:

Priority

Priority:

Priority

Priority:

Provide

Provide:

Provide

Provide:

Provider

Provider:

Put

Put:

Queries

Queries:

Query

Query:

Queue

Queue:

Queue

Queue:

RPC_DUBBO_KEY

RPC_DUBBO_KEY:

RPC_GRPC_KEY

RPC_GRPC_KEY:

RULES_KEY

RULES_KEY:

RabbitMQListener

RabbitMQListener:

RabbitMQListenerOptions

RabbitMQListenerOptions:

Redirect

Redirect:

ReflectResult

ReflectResult:

RequestIP

RequestIP:

RequestMapping

RequestMapping:

RequestMethod

RequestMethod:

RequestPath

RequestPath:

ResolveFilter

ResolveFilter:

ResolveFilter

ResolveFilter:

RouteParamTypes

RouteParamTypes:

RouterOption

RouterOption:

RouterParamValue

RouterParamValue:

Rule

Rule:

Rule

Rule:

RuleOptions

RuleOptions:

RuleOptions

RuleOptions:

RuleType

RuleType:

RuleType

RuleType:

RuleType

RuleType:

SCHEDULE_KEY

SCHEDULE_KEY:

SERVERLESS_FUNC_KEY

SERVERLESS_FUNC_KEY:

Schedule

Schedule:

Schedule

Schedule:

ScheduleOpts

ScheduleOpts:

ScheduleOpts

ScheduleOpts:

Scope

Scope:

Scope

Scope:

ScopeEnum

ScopeEnum:

ServerlessFunction

ServerlessFunction:

ServerlessTrigger

ServerlessTrigger:

ServerlessTriggerType

ServerlessTriggerType:

Session

Session:

SetHeader

SetHeader:

TAGGED

TAGGED:

TAGGED_CLS

TAGGED_CLS:

TAGGED_FUN

TAGGED_FUN:

TAGGED_PROP

TAGGED_PROP:

TSDesignType

TSDesignType:

TagClsMetadata

TagClsMetadata:

TagPropsMetadata

TagPropsMetadata:

Task

Task:

Task

Task:

TaskLocal

TaskLocal:

TaskLocal

TaskLocal:

Validate

Validate:

Validate

Validate:

WEB_RESPONSE_CONTENT_TYPE

WEB_RESPONSE_CONTENT_TYPE:

WEB_RESPONSE_HEADER

WEB_RESPONSE_HEADER:

WEB_RESPONSE_HTTP_CODE

WEB_RESPONSE_HTTP_CODE:

WEB_RESPONSE_KEY

WEB_RESPONSE_KEY:

WEB_RESPONSE_REDIRECT

WEB_RESPONSE_REDIRECT:

WEB_RESPONSE_RENDER

WEB_RESPONSE_RENDER:

WEB_ROUTER_KEY

WEB_ROUTER_KEY:

WEB_ROUTER_PARAM_KEY

WEB_ROUTER_PARAM_KEY:

WSBroadCast

WSBroadCast:

WSController

WSController:

WSControllerOption

WSControllerOption:

WSEmit

WSEmit:

WSEventInfo

WSEventInfo:

WSEventTypeEnum

WSEventTypeEnum:

WS_CONTROLLER_KEY

WS_CONTROLLER_KEY:

WS_EVENT_KEY

WS_EVENT_KEY:

attachClassMetadata

attachClassMetadata:

attachConstructorDataOnClass

attachConstructorDataOnClass:

attachMethodDataToClass

attachMethodDataToClass:

attachMethodMetadata

attachMethodMetadata:

attachPropertyDataToClass

attachPropertyDataToClass:

attachPropertyMetadata

attachPropertyMetadata:

classNamed

classNamed:

clearAllModule

clearAllModule:

createRender

createRender:

generateProvideId

generateProvideId:

generateRandomId

generateRandomId:

getClassExtendedMetadata

getClassExtendedMetadata:

getClassMetadata

getClassMetadata:

getConstructorInject

getConstructorInject:

getMethodDataFromClass

getMethodDataFromClass:

getMethodMetadata

getMethodMetadata:

getMethodParamTypes

getMethodParamTypes:

getMethodReturnTypes

getMethodReturnTypes:

getObjectDefProps

getObjectDefProps:

getObjectDefinition

getObjectDefinition:

getParamNames

getParamNames:

getPropertyDataFromClass

getPropertyDataFromClass:

getPropertyInject

getPropertyInject:

getPropertyMetadata

getPropertyMetadata:

getPropertyType

getPropertyType:

getProviderId

getProviderId:

getProviderUUId

getProviderUUId:

isAsyncFunction

isAsyncFunction:

isClass

isClass:

isFunction

isFunction:

isGeneratorFunction

isGeneratorFunction:

isMap

isMap:

isNull

isNull:

isNullOrUndefined

isNullOrUndefined:

isNumber

isNumber:

isObject

isObject:

isPromise

isPromise:

isProvide

isProvide:

isProxy

isProxy:

isRegExp

isRegExp:

isSet

isSet:

isUndefined

isUndefined:

listMethodDataFromClass

listMethodDataFromClass:

listModule

listModule:

listPreloadModule

listPreloadModule:

listPropertyDataFromClass

listPropertyDataFromClass:

resetModule

resetModule:

saveClassMetadata

saveClassMetadata:

saveConstructorInject

saveConstructorInject:

saveMethodDataToClass

saveMethodDataToClass:

saveMethodMetadata

saveMethodMetadata:

saveModule

saveModule:

saveObjectDefProps

saveObjectDefProps:

savePreloadModule

savePreloadModule:

savePropertyDataToClass

savePropertyDataToClass:

savePropertyInject

savePropertyInject:

savePropertyMetadata

savePropertyMetadata:

saveProviderId

saveProviderId:

sleep

sleep:

throwErrorForTest

throwErrorForTest:

Type aliases

DecoratorKey

DecoratorKey: string | symbol

MiddlewareParamArray

MiddlewareParamArray: Array<Middleware | RequestHandler | string>

ObjectIdentifier

ObjectIdentifier: string

Variables

Const ALL

ALL: "common:all_value_key" = "common:all_value_key"

Const APPLICATION_KEY

APPLICATION_KEY: "__midway_framework_app__" = "__midway_framework_app__"

Const ASPECT_KEY

ASPECT_KEY: "common:aspect" = "common:aspect"

Const All

All: (Anonymous function) = createMappingDecorator(RequestMethod.ALL)

Routes all HTTP requests to the specified path.

Const CLASS_KEY_CONSTRUCTOR

CLASS_KEY_CONSTRUCTOR: "midway:class_key_constructor" = "midway:class_key_constructor"

Const CONFIGURATION_KEY

CONFIGURATION_KEY: "common:configuration" = "common:configuration"

Const CONFIG_KEY

CONFIG_KEY: "config" = "config"

Const CONTROLLER_KEY

CONTROLLER_KEY: "web:controller" = "web:controller"

Const DUPLICATED_INJECTABLE_DECORATOR

DUPLICATED_INJECTABLE_DECORATOR: "Cannot apply @injectable decorator multiple times." = "Cannot apply @injectable decorator multiple times."

Const DUPLICATED_METADATA

DUPLICATED_METADATA: "Metadata key was used more than once in a parameter:" = "Metadata key was used more than once in a parameter:"

Const Del

Del: (Anonymous function) = createMappingDecorator(RequestMethod.DELETE)

Routes HTTP DELETE requests to the specified path.

Const Emit

Emit: WSEmit = WSEmit
deprecated

please use @WSEmit

Const FUNC_KEY

FUNC_KEY: "faas:func" = "faas:func"

Const Get

Get: (Anonymous function) = createMappingDecorator(RequestMethod.GET)

Routes HTTP GET requests to the specified path.

Const HANDLER_KEY

HANDLER_KEY: "faas:handler" = "faas:handler"

Const HSF_KEY

HSF_KEY: "rpc:hsf" = "rpc:hsf"

Const Head

Head: (Anonymous function) = createMappingDecorator(RequestMethod.HEAD)

Routes HTTP HEAD requests to the specified path.

Const INJECT_CLASS_KEY_PREFIX

INJECT_CLASS_KEY_PREFIX: "INJECTION_CLASS_META_DATA" = "INJECTION_CLASS_META_DATA"

Const INJECT_TAG

INJECT_TAG: "inject" = "inject"

Const INVALID_DECORATOR_OPERATION

INVALID_DECORATOR_OPERATION: string = 'The @inject @multiInject @tagged and @named decorators ' +'must be applied to the parameters of a class constructor or a class property.'

Const LIFECYCLE_IDENTIFIER_PREFIX

LIFECYCLE_IDENTIFIER_PREFIX: "__lifecycle__" = "__lifecycle__"

Const LOGGER_KEY

LOGGER_KEY: "logger" = "logger"

Const MAIN_MODULE_KEY

MAIN_MODULE_KEY: "__main__" = "__main__"

Const MODULE_TASK_KEY

MODULE_TASK_KEY: "task:task" = "task:task"

Const MODULE_TASK_METADATA

MODULE_TASK_METADATA: "task:task:options" = "task:task:options"

Const MODULE_TASK_QUEUE_KEY

MODULE_TASK_QUEUE_KEY: "task:task:queue" = "task:task:queue"

Const MODULE_TASK_QUEUE_OPTIONS

MODULE_TASK_QUEUE_OPTIONS: "task:task:queue:options" = "task:task:queue:options"

Const MODULE_TASK_TASK_LOCAL_KEY

MODULE_TASK_TASK_LOCAL_KEY: "task:task:task_local" = "task:task:task_local"

Const MODULE_TASK_TASK_LOCAL_OPTIONS

MODULE_TASK_TASK_LOCAL_OPTIONS: "task:task:task_local:options" = "task:task:task_local:options"

Const MS_CONSUMER_KEY

MS_CONSUMER_KEY: "ms:consumer" = "ms:consumer"

Const MS_DUBBO_METHOD_KEY

MS_DUBBO_METHOD_KEY: "ms:dubbo:method" = "ms:dubbo:method"

Const MS_GRPC_METHOD_KEY

MS_GRPC_METHOD_KEY: "ms:grpc:method" = "ms:grpc:method"

Const MS_HSF_METHOD_KEY

MS_HSF_METHOD_KEY: "ms:hsf:method" = "ms:hsf:method"

Const MS_PRODUCER_KEY

MS_PRODUCER_KEY: "ms:producer" = "ms:producer"

Const MS_PROVIDER_KEY

MS_PROVIDER_KEY: "ms:provider" = "ms:provider"

Const NAMED_TAG

NAMED_TAG: "named" = "named"

Const OBJ_DEF_CLS

OBJ_DEF_CLS: "injection:object_definition_class" = "injection:object_definition_class"

Const OnConnection

OnConnection: OnWSConnection = OnWSConnection
deprecated

please use @OnWSConnection

Const OnDisConnection

OnDisConnection: OnWSDisConnection = OnWSDisConnection
deprecated

please use @OnWSDisConnection

Const OnMessage

OnMessage: OnWSMessage = OnWSMessage
deprecated

please use @OnWSMessage

Const Options

Options: (Anonymous function) = createMappingDecorator(RequestMethod.OPTIONS)

Routes HTTP OPTIONS requests to the specified path.

Const PIPELINE_IDENTIFIER

PIPELINE_IDENTIFIER: "__pipeline_identifier__" = "__pipeline_identifier__"

Const PLUGIN_KEY

PLUGIN_KEY: "plugin" = "plugin"

Const PRELOAD_MODULE_KEY

PRELOAD_MODULE_KEY: "INJECTION_PRELOAD_MODULE_KEY" = "INJECTION_PRELOAD_MODULE_KEY"

Const PRIORITY_KEY

PRIORITY_KEY: "common:priority" = "common:priority"

Const PRIVATE_META_DATA_KEY

PRIVATE_META_DATA_KEY: "__midway_private_meta_data__" = "__midway_private_meta_data__"

Const Patch

Patch: (Anonymous function) = createMappingDecorator(RequestMethod.PATCH)

Routes HTTP PATCH requests to the specified path.

Const Post

Post: (Anonymous function) = createMappingDecorator(RequestMethod.POST)

Routes HTTP POST requests to the specified path.

Const Put

Put: (Anonymous function) = createMappingDecorator(RequestMethod.PUT)

Routes HTTP PUT requests to the specified path.

Const RPC_DUBBO_KEY

RPC_DUBBO_KEY: "rpc:dubbo" = "rpc:dubbo"

Const RPC_GRPC_KEY

RPC_GRPC_KEY: "rpc:grpc" = "rpc:grpc"

Const RULES_KEY

RULES_KEY: "common:rules" = "common:rules"

Const SCHEDULE_KEY

SCHEDULE_KEY: "common:schedule" = "common:schedule"

Const SERVERLESS_FUNC_KEY

SERVERLESS_FUNC_KEY: "faas:serverless:function" = "faas:serverless:function"

Const STRIP_COMMENTS

STRIP_COMMENTS: RegExp = /((\/\/.*$)|(\/\*[\s\S]*?\*\/))/gm

Const TAGGED

TAGGED: "injection:tagged" = "injection:tagged"

Const TAGGED_CLS

TAGGED_CLS: "injection:tagged_class" = "injection:tagged_class"

Const TAGGED_FUN

TAGGED_FUN: "injection:tagged_function" = "injection:tagged_function"

Const TAGGED_PROP

TAGGED_PROP: "injection:tagged_props" = "injection:tagged_props"

Const ToString

ToString: toString = Function.prototype.toString

Const WEB_RESPONSE_CONTENT_TYPE

WEB_RESPONSE_CONTENT_TYPE: "web:response_content_type" = "web:response_content_type"

Const WEB_RESPONSE_HEADER

WEB_RESPONSE_HEADER: "web:response_header" = "web:response_header"

Const WEB_RESPONSE_HTTP_CODE

WEB_RESPONSE_HTTP_CODE: "web:response_http_code" = "web:response_http_code"

Const WEB_RESPONSE_KEY

WEB_RESPONSE_KEY: "web:response" = "web:response"

Const WEB_RESPONSE_REDIRECT

WEB_RESPONSE_REDIRECT: "web:response_redirect" = "web:response_redirect"

Const WEB_RESPONSE_RENDER

WEB_RESPONSE_RENDER: "web:response_render" = "web:response_render"

Const WEB_ROUTER_KEY

WEB_ROUTER_KEY: "web:router" = "web:router"

Const WEB_ROUTER_PARAM_KEY

WEB_ROUTER_PARAM_KEY: "web:router_param" = "web:router_param"

Const WS_CONTROLLER_KEY

WS_CONTROLLER_KEY: "ws:controller" = "ws:controller"

Const WS_EVENT_KEY

WS_EVENT_KEY: "ws:event" = "ws:event"

Const debug

debug: any = require('util').debuglog('decorator:context:obj_def')

Const debug

debug: any = require('util').debuglog('decorator:manager')

Let manager

manager: DecoratorManager = new DecoratorManager()

Const testKeyMap

testKeyMap: Map<DecoratorKey, Error> = new Map<DecoratorKey, Error>()

Functions

App

Aspect

  • Aspect(aspectTarget: any | any[], match?: string | function, priority?: number): (Anonymous function)

Async

  • Async(): (Anonymous function)

Autoload

  • Autoload(): (Anonymous function)

Autowire

  • Autowire(isAutowire?: boolean): (Anonymous function)

Const Body

  • Body(property?: string): (Anonymous function)

Config

  • Config(identifier?: string): (Anonymous function)

Configuration

Consumer

  • Consumer(type: MQTT): ClassDecorator
  • Consumer(type: RABBITMQ, options?: any): ClassDecorator

ContentType

  • ContentType(contentType: string): (Anonymous function)

Controller

  • Controller(prefix?: string, routerOptions?: object): ClassDecorator
  • Parameters

    • Default value prefix: string = "/"
    • Default value routerOptions: object = { middleware: [], sensitive: true }
      • Optional description?: string
      • Optional middleware?: MiddlewareParamArray
      • Optional sensitive?: boolean
      • Optional tagName?: string

    Returns ClassDecorator

Destroy

  • Destroy(): (Anonymous function)

DubboMethod

  • DubboMethod(methodName?: string): MethodDecorator

Const File

Const Files

Func

GrpcMethod

  • GrpcMethod(methodOptions?: object): MethodDecorator

HSF

  • HSF(hsfOption?: HSFOpts): ClassDecorator

HSFMethod

  • HSFMethod(methodName?: string): MethodDecorator

Handler

Const Headers

  • Headers(property?: string): (Anonymous function)

HttpCode

  • HttpCode(code: number): (Anonymous function)

Init

  • Init(): (Anonymous function)

Inject

Logger

  • Logger(identifier?: string): (Anonymous function)

OmitDto

  • OmitDto<T, K>(dto: Dto<T>, keys: K[]): Dto<Omit<T, typeof keys[number]>>

OnWSConnection

  • OnWSConnection(): MethodDecorator

OnWSDisConnection

  • OnWSDisConnection(): MethodDecorator

OnWSMessage

  • OnWSMessage(eventName: string): MethodDecorator

Const Param

  • Param(property?: string): (Anonymous function)

PickDto

  • PickDto<T, K>(dto: Dto<T>, keys: K[]): Dto<Pick<T, typeof keys[number]>>

Pipeline

Plugin

  • Plugin(identifier?: string): (Anonymous function)

Priority

  • Priority(priority: number): ClassDecorator

Provide

Provider

  • Provider(type: GRPC, metadata?: ProviderOptions): ClassDecorator
  • Provider(type: DUBBO, metadata?: any): ClassDecorator

Const Queries

  • Queries(property?: string): (Anonymous function)

Const Query

  • Query(property?: string): (Anonymous function)

Queue

  • Queue(options?: any): (Anonymous function)

RabbitMQListener

Redirect

  • Redirect(url: string, code?: number): (Anonymous function)

Const RequestIP

  • RequestIP(): (Anonymous function)

Const RequestMapping

Const RequestPath

  • RequestPath(): (Anonymous function)

Rule

  • Rule(rule: any, options?: RuleOptions): (Anonymous function)

Schedule

  • Schedule(scheduleOpts: ScheduleOpts | string): (Anonymous function)

Scope

  • Scope(scope?: ScopeEnum): (Anonymous function)

ServerlessFunction

ServerlessTrigger

Const Session

  • Session(property?: string): (Anonymous function)

SetHeader

  • SetHeader(headerKey: string | Record<string, any>, value?: string): (Anonymous function)

Task

  • Task(options: any): (Anonymous function)

TaskLocal

  • TaskLocal(options: any): (Anonymous function)

Validate

  • Validate(isTransform?: boolean): (Anonymous function)

WSBroadCast

  • WSBroadCast(messageName?: string, roomName?: string | string[]): MethodDecorator

WSController

  • WSController(namespace?: string | RegExp, routerOptions?: object): ClassDecorator

WSEmit

  • WSEmit(messageName: string, roomName?: string | string[]): MethodDecorator

_tagParameterOrProperty

  • _tagParameterOrProperty(metadataKey: string, annotationTarget: any, propertyName: string, metadata: TagPropsMetadata, parameterIndex?: number): void

attachClassMetadata

  • attachClassMetadata(decoratorNameKey: DecoratorKey, data: any, target: any, groupBy?: string): void

attachConstructorDataOnClass

  • attachConstructorDataOnClass(identifier: any, clz: any, type: any, index: any): void

attachMethodDataToClass

  • attachMethodDataToClass(decoratorNameKey: DecoratorKey, data: any, target: any, method: any): void

attachMethodMetadata

  • attachMethodMetadata(decoratorNameKey: DecoratorKey, data: any, target: any, method: any): void

attachPropertyDataToClass

  • attachPropertyDataToClass(decoratorNameKey: DecoratorKey, data: any, target: any, propertyName: any, groupBy?: string): void

attachPropertyMetadata

  • attachPropertyMetadata(decoratorNameKey: DecoratorKey, data: any, target: any, propertyName: any): void

classNamed

  • classNamed(name: string): string

clearAllModule

  • clearAllModule(): void

Const createMappingDecorator

  • createMappingDecorator(method: string): (Anonymous function)

Const createParamMapping

createRender

  • createRender(RenderEngine: object): (Anonymous function)

fnBody

  • fnBody(fn: any): any

generateProvideId

  • generateProvideId(provideId: string, namespace?: string): string

generateRandomId

  • generateRandomId(): string

getClassExtendedMetadata

  • getClassExtendedMetadata(decoratorNameKey: DecoratorKey, target: any): any

getClassMetadata

  • getClassMetadata(decoratorNameKey: DecoratorKey, target: any): any

getConstructorInject

getMethodDataFromClass

  • getMethodDataFromClass(decoratorNameKey: DecoratorKey, target: any, method: any): any

getMethodMetadata

  • getMethodMetadata(decoratorNameKey: DecoratorKey, target: any, method: any): any

getMethodParamTypes

  • getMethodParamTypes(target: any, propertyKey: string | symbol): any

getMethodReturnTypes

  • getMethodReturnTypes(target: any, propertyKey: string | symbol): any

getObjectDefProps

getObjectDefinition

getParamNames

  • getParamNames(func: any): string[]

getPropertyDataFromClass

  • getPropertyDataFromClass(decoratorNameKey: DecoratorKey, target: any, propertyName: any): any

getPropertyInject

getPropertyMetadata

  • getPropertyMetadata(decoratorNameKey: DecoratorKey, target: any, propertyName: any): any

getPropertyType

  • getPropertyType(target: any, propertyKey: string | symbol): TSDesignType

getProviderId

  • getProviderId(module: any): string

getProviderUUId

  • getProviderUUId(module: any): string

isAsyncFunction

  • isAsyncFunction(value: any): boolean

isClass

  • isClass(fn: any): boolean

isFunction

  • isFunction(value: any): boolean

isGeneratorFunction

  • isGeneratorFunction(value: any): boolean

isMap

  • isMap(value: any): boolean

isNull

  • isNull(value: any): boolean

isNullOrUndefined

  • isNullOrUndefined(value: any): boolean

isNumber

  • isNumber(value: any): boolean

isObject

  • isObject(value: any): boolean

isPromise

  • isPromise(value: any): boolean

isProvide

  • isProvide(target: any): boolean

isProxy

  • isProxy(value: any): boolean

isRegExp

  • isRegExp(value: any): boolean

isSet

  • isSet(value: any): boolean

isUndefined

  • isUndefined(value: any): boolean

listMethodDataFromClass

  • listMethodDataFromClass(decoratorNameKey: DecoratorKey, target: any): any[]

listModule

  • listModule(decoratorNameKey: DecoratorKey, filter?: function): any[]

listPreloadModule

  • listPreloadModule(): any[]

listPropertyDataFromClass

  • listPropertyDataFromClass(decoratorNameKey: DecoratorKey, target: any): any[]

mergeMeta

  • mergeMeta(target: any, src: any): any

resetModule

saveClassMetadata

  • saveClassMetadata(decoratorNameKey: DecoratorKey, data: any, target: any): void

saveConstructorInject

saveMethodDataToClass

  • saveMethodDataToClass(decoratorNameKey: DecoratorKey, data: any, target: any, method: any): void

saveMethodMetadata

  • saveMethodMetadata(decoratorNameKey: DecoratorKey, data: any, target: any, method: any): void

saveModule

  • saveModule(decoratorNameKey: DecoratorKey, target: any): void

saveObjectDefProps

  • saveObjectDefProps(target: any, props?: object): any

savePreloadModule

  • savePreloadModule(target: any): void

savePropertyDataToClass

  • savePropertyDataToClass(decoratorNameKey: DecoratorKey, data: any, target: any, propertyName: any): void

savePropertyInject

savePropertyMetadata

  • savePropertyMetadata(decoratorNameKey: DecoratorKey, data: any, target: any, propertyName: any): void

saveProviderId

  • saveProviderId(identifier: ObjectIdentifier, target: any, override?: boolean): any

sleep

  • sleep(sleepTime?: number): Promise<void>

throwErrorForTest

transformTypeFromTSDesign

Object literals

Const RequestMethod

RequestMethod: object

ALL

ALL: string = "all"

DELETE

DELETE: string = "delete"

GET

GET: string = "get"

HEAD

HEAD: string = "head"

OPTIONS

OPTIONS: string = "options"

PATCH

PATCH: string = "patch"

POST

POST: string = "post"

PUT

PUT: string = "put"

Const defaultMetadata

defaultMetadata: object

middleware

middleware: undefined[] = []

path

path: string = "/"

requestMethod

requestMethod: string = RequestMethod.GET

routerName

routerName: null = null

Generated using TypeDoc