IMidwayBaseApplication <CTX>

Index

Methods

• addConfigObject
• createAnonymousContext
• createLogger
• getAppDir
• getApplicationContext
• getAttr
• getBaseDir
• getConfig
• getCoreLogger
• getEnv
• getFramework
• getFrameworkType
• getLogger
• getMiddleware
• getNamespace
• getProcessType
• getProjectName
• setAttr
• setContextLoggerClass
• useFilter
• useGuard
• useMiddleware

Methods

addConfigObject

• addConfigObject(obj: any): any

• Add new value to current config

createAnonymousContext

• createAnonymousContext(...args: any[]): CTX

• create a context with RequestContainer

createLogger

• createLogger(name: string, options: MidwayLoggerOptions): ILogger

• Create a logger by name and options

getAppDir

• getAppDir(): string

• Get a project root directory, without src or dist

getApplicationContext

• getApplicationContext(): IMidwayContainer

• Get global Midway IoC Container

getAttr

• getAttr<T>(key: string): T

• Get value from app attribute map

  ---

  Type parameters

  • T

getBaseDir

• getBaseDir(): string

• Get a base directory for project, with src or dist

getConfig

• getConfig(key?: string): any

• Get all configuration values or get the specified configuration through parameters

getCoreLogger

• getCoreLogger(): ILogger

• Get core logger

getEnv

• getEnv(): string

• Get a environment value, read from MIDWAY_SERVER_ENV

getFramework

• getFramework(): IMidwayFramework<IMidwayBaseApplication<CTX>, CTX, unknown, unknown, unknown>

• get current related framework

getFrameworkType

• getFrameworkType(): FrameworkType

• @deprecated

  Get current framework type in MidwayFrameworkType enum

getLogger

• getLogger(name?: string): ILogger

• Get default logger object or get the specified logger through parameters

getMiddleware

• getMiddleware<R, N>(): IMiddlewareManager<CTX, R, N>

• get global middleware

  ---

  Type parameters

  • R
  • N

getNamespace

• getNamespace(): string

• get current namespace

getProcessType

• getProcessType(): MidwayProcessTypeEnum

• Get current running process type, app or agent, just for egg

getProjectName

• getProjectName(): string

• Get project name, just package.json name

setAttr

• setAttr(key: string, value: any): any

• Set value to app attribute map

setContextLoggerClass

• setContextLoggerClass(BaseContextLoggerClass: any): void

• Set a context logger class to change default context logger format

useFilter

• useFilter<R, N>(Filter: CommonFilterUnion<CTX, R, N>): void

• add exception filter

  ---

  Type parameters

  • R
  • N

useGuard

• useGuard(guard: CommonGuardUnion<CTX>): void

• add global guard

useMiddleware

• useMiddleware<R, N>(Middleware: CommonMiddlewareUnion<CTX, R, N>): void

• add global filter to app

  ---

  Type parameters

  • R
  • N