Preparing search index...
The search index is not available
Midway v3 Api Reference
Midway v3 Api Reference
@midwayjs/core
GUARD_KEY
Variable GUARD_KEY
Const
GUARD_
KEY
:
"common:guard"
= 'common:guard'
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Modules
Midway v3
Api
Reference
@midwayjs/bootstrap
@midwayjs/core
Consumer
Metadata
FaaSMetadata
GRPCMetadata
@midwayjs/decorator
@midwayjs/koa
Base
Type
Grpc
Stream
Type
Enum
Http
Status
Inject
Mode
Enum
MSListener
Type
MSProvider
Type
Midway
Process
Type
Enum
Object
Life
Cycle
Event
Route
Param
Types
Scope
Enum
Serverless
Trigger
Type
WSEvent
Type
Enum
Abstract
File
Detector
Base
Framework
Context
Middleware
Manager
Custom
Module
Detector
Data
Listener
Data
Source
Manager
Decorator
Manager
Directory
File
Detector
Filter
Manager
Framework
Type
Functional
Configuration
Http
Client
Logger
Factory
Midway
Application
Manager
Midway
Aspect
Service
Midway
Common
Error
Midway
Config
Missing
Error
Midway
Config
Service
Midway
Container
Midway
Decorator
Service
Midway
Definition
Not
Found
Error
Midway
Duplicate
Class
Name
Error
Midway
Duplicate
Controller
Options
Error
Midway
Duplicate
Route
Error
Midway
Environment
Service
Midway
Error
Midway
Feature
No
Longer
Supported
Error
Midway
Feature
Not
Implemented
Error
Midway
Framework
Service
Midway
Framework
Type
Midway
Http
Error
Midway
Inconsistent
Version
Error
Midway
Information
Service
Midway
Invalid
Config
Error
Midway
Invoke
Forbidden
Error
Midway
Life
Cycle
Service
Midway
Logger
Service
Midway
Middleware
Service
Midway
Missing
Import
Component
Error
Midway
Mock
Service
Midway
Parameter
Error
Midway
Pipeline
Service
Midway
Request
Container
Midway
Resolver
Missing
Error
Midway
Retry
Exceeded
Max
Times
Error
Midway
Serverless
Function
Service
Midway
Singleton
Inject
Request
Error
Midway
Use
Wrong
Method
Error
Midway
Util
Http
Client
Timeout
Error
Midway
Web
Router
Service
Pipeline
Context
Service
Factory
Web
Controller
Generator
Web
Router
Collector
Aspect
Metadata
Async
Context
Async
Context
Manager
Common
Schedule
Context
Controller
Option
Create
Data
Source
Instance
Options
HSFOpts
IComponent
Info
IConfig
Service
IConfiguration
Options
IEnvironment
Service
IFile
Detector
IFilter
IGuard
IIdentifier
Relation
Ship
IInformation
Service
ILife
Cycle
IManaged
Instance
IManaged
Resolver
IManaged
Resolver
Factory
Create
Options
IMethod
Aspect
IMiddleware
IMiddleware
Manager
IMidway
Base
Application
IMidway
Bootstrap
Options
IMidway
Container
IMidway
Framework
IModule
Store
IObject
Creator
IObject
Definition
IObject
Definition
Registry
IObject
Factory
IObject
Life
Cycle
IPipeline
Context
IPipeline
Handler
IPipeline
Options
IPipeline
Result
IProperties
IResponse
IService
Factory
ISimulation
IValve
Handler
Injection
Configuration
Options
Join
Point
Kafka
Listener
Options
Method
Decorator
Meta
Data
Method
Decorator
Options
Midway
App
Info
Midway
Config
Midway
Core
Default
Config
Object
Before
Bind
Options
Object
Before
Created
Options
Object
Before
Destroy
Options
Object
Created
Options
Object
Definition
Options
Object
Init
Options
Param
Decorator
Options
Parameter
Decorator
Meta
Data
Pipe
Transform
RabbitMQListener
Options
Reflect
Result
Resolve
Filter
Router
Collector
Options
Router
Info
Router
Option
Router
Param
Value
Router
Priority
Schedule
Opts
TSDesign
Type
Tag
Cls
Metadata
Tag
Props
Metadata
Transform
Options
WSController
Option
WSEvent
Info
Class
Middleware
Common
Filter
Union
Common
Guard
Union
Common
Middleware
Common
Middleware
Union
Consumer
Run
Config
Consumer
Subscribe
Topic
Consumer
Subscribe
Topics
Custom
Param
Decorator
Data
Source
Manager
Config
Option
Dynamic
Router
Info
Express
Like
Custom
Param
Decorator
File
Config
Option
Function
Middleware
Group
Mode
Type
Handler
Function
IApplication
Context
IMidway
Application
IMidway
Context
Ignore
Matcher
Koa
Like
Custom
Param
Decorator
Match
Pattern
Method
Handler
Function
Middleware
Param
Array
Middleware
Respond
Next
Function
Object
Context
Object
Identifier
Parameter
Handler
Function
Pipe
Transform
Function
Pipe
Union
Transform
Power
Partial
Res
Or
Message
Service
Factory
Config
Option
With
Fn
Without
Fn
Writable
ALL
APPLICATION_
CONTEXT_
KEY
APPLICATION_
KEY
ASPECT_
KEY
ASYNC_
CONTEXT_
KEY
ASYNC_
CONTEXT_
MANAGER_
KEY
ASYNC_
ROOT_
CONTEXT
CATCH_
KEY
CLASS_
KEY_
CONSTRUCTOR
CONFIGURATION_
KEY
CONFIG_
KEY
CONTROLLER_
KEY
DEFAULT_
PATTERN
FACTORY_
SERVICE_
CLIENT_
KEY
FORMAT
FRAMEWORK_
KEY
FUNCTION_
INJECT_
KEY
FUNC_
KEY
File
Utils
Framework
Error
Enum
GUARD_
KEY
HSF_
KEY
HTTP_
SERVER_
KEY
IGNORE_
PATTERN
INJECT_
CLASS_
KEY_
PREFIX
INJECT_
CUSTOM_
METHOD
INJECT_
CUSTOM_
PARAM
INJECT_
CUSTOM_
PROPERTY
INJECT_
TAG
KEYS
LIFECYCLE_
IDENTIFIER_
PREFIX
LOGGER_
KEY
MAIN_
MODULE_
KEY
MATCH_
KEY
MIDWAY_
LOGGER_
WRITEABLE_
DIR
MOCK_
KEY
MODULE_
TASK_
KEY
MODULE_
TASK_
METADATA
MODULE_
TASK_
QUEUE_
KEY
MODULE_
TASK_
QUEUE_
OPTIONS
MODULE_
TASK_
TASK_
LOCAL_
KEY
MODULE_
TASK_
TASK_
LOCAL_
OPTIONS
MS_
CONSUMER_
KEY
MS_
DUBBO_
METHOD_
KEY
MS_
GRPC_
METHOD_
KEY
MS_
HSF_
METHOD_
KEY
MS_
PRODUCER_
KEY
MS_
PROVIDER_
KEY
NAMED_
TAG
OBJ_
DEF_
CLS
PIPELINE_
IDENTIFIER
PLUGIN_
KEY
PRELOAD_
MODULE_
KEY
PRIVATE_
META_
DATA_
KEY
Path
File
Util
Path
To
Regexp
Util
REQUEST_
CTX_
KEY
REQUEST_
CTX_
LOGGER_
CACHE_
KEY
REQUEST_
OBJ_
CTX_
KEY
RPC_
DUBBO_
KEY
RPC_
GRPC_
KEY
Request
Method
SCHEDULE_
KEY
SERVERLESS_
FUNC_
KEY
TAGGED_
CLS
TAGGED_
FUN
Types
Utils
WEB_
RESPONSE_
CONTENT_
TYPE
WEB_
RESPONSE_
HEADER
WEB_
RESPONSE_
HTTP_
CODE
WEB_
RESPONSE_
KEY
WEB_
RESPONSE_
REDIRECT
WEB_
RESPONSE_
RENDER
WEB_
ROUTER_
KEY
WEB_
ROUTER_
PARAM_
KEY
WS_
CONTROLLER_
KEY
WS_
EVENT_
KEY
http
Error
All
App
Application
Context
Aspect
Autoload
Body
Catch
Config
Configuration
Consumer
Content
Type
Controller
Del
Destroy
Dubbo
Method
Emit
Fields
File
Files
Framework
Get
Grpc
Method
Guard
HSF
Head
Headers
Http
Code
Init
Inject
Inject
Client
Kafka
Listener
Logger
Match
Middleware
Mock
On
Connection
On
Dis
Connection
On
Message
OnWSConnection
OnWSDis
Connection
OnWSMessage
Options
Param
Patch
Pipe
Pipeline
Plugin
Post
Provide
Provider
Put
Queries
Query
Queue
RabbitMQListener
Redirect
RequestIP
Request
Mapping
Request
Path
Schedule
Scope
Serverless
Function
Serverless
Trigger
Session
Set
Header
Singleton
Task
Task
Local
Use
Guard
WSBroad
Cast
WSController
WSEmit
attach
Class
Metadata
attach
Property
Data
To
Class
attach
Property
Metadata
bind
Container
clear
All
Module
clear
Bind
Container
create
Configuration
create
Custom
Method
Decorator
create
Custom
Param
Decorator
create
Custom
Property
Decorator
create
Render
create
Request
Param
Decorator
delegate
Target
All
Prototype
Method
delegate
Target
Method
delegate
Target
Properties
delegate
Target
Prototype
Method
deprecated
Output
destroy
Global
Application
Context
extend
extract
Express
Like
Value
extract
Koa
Like
Value
get
Class
Extended
Metadata
get
Class
Metadata
get
Current
Application
Context
get
Current
Async
Context
Manager
get
Current
Main
App
get
Current
Main
Framework
get
Method
Param
Types
get
Method
Return
Types
get
Object
Definition
get
Property
Data
From
Class
get
Property
Inject
get
Property
Metadata
get
Property
Type
get
Provider
Id
get
Provider
Name
get
ProviderUUId
initialize
Global
Application
Context
is
Provide
list
Module
list
Preload
Module
list
Property
Data
From
Class
make
Http
Request
path
Matching
prepare
Global
Application
Context
provider
Wrapper
register
Error
Code
reset
Module
retry
With
retry
With
Async
safe
Require
safely
Get
save
Class
Metadata
save
Module
save
Object
Definition
save
Preload
Module
save
Property
Data
To
Class
save
Property
Inject
save
Property
Metadata
save
Provider
Id
sleep
transform
Request
Object
By
Type
transform
Type
FromTSDesign
wrap
Async
wrap
Middleware
Generated using
TypeDoc