Interface IMidwayBaseApplication<CTX>

Type Parameters

CTX extends IMidwayContext

Hierarchy

IMidwayBaseApplication

Methods

addConfigObject

addConfigObject(obj: any): any
Add new value to current config
Parameters
- obj: any
Returns any
- Defined in packages/core/src/interface.ts:963

createAnonymousContext

createAnonymousContext(...args: any[]): CTX
create a context with RequestContainer
Parameters
- Rest ...args: any[]
Returns CTX
- Defined in packages/core/src/interface.ts:951

createLogger

createLogger(name: string, options: LoggerOptions): ILogger
Create a logger by name and options
Parameters
- name: string
- options: LoggerOptions
Returns ILogger
- Defined in packages/core/src/interface.ts:940

getAppDir

getAppDir(): string
Get a project root directory, without src or dist

Returns string
- Defined in packages/core/src/interface.ts:890

getApplicationContext

getApplicationContext(): IMidwayContainer
Get global Midway IoC Container

Returns IMidwayContainer
- Defined in packages/core/src/interface.ts:916

getAttr

getAttr<T>(key: string): T
Get value from app attribute map
Type Parameters
- T
Parameters
- key: string
Returns T
- Defined in packages/core/src/interface.ts:976

getBaseDir

getBaseDir(): string
Get a base directory for project, with src or dist

Returns string
- Defined in packages/core/src/interface.ts:885

getConfig

getConfig(key?: string): any
Get all configuration values or get the specified configuration through parameters
Parameters
- Optional key: string
  
  config key
Returns any
- Defined in packages/core/src/interface.ts:922

getCoreLogger

getCoreLogger(): ILogger
Get core logger

Returns ILogger
- Defined in packages/core/src/interface.ts:933

getEnv

getEnv(): string
Get a environment value, read from MIDWAY_SERVER_ENV

Returns string
- Defined in packages/core/src/interface.ts:895

getFramework

getFramework(): IMidwayFramework<IMidwayBaseApplication<CTX>, CTX, unknown, unknown, unknown>
get current related framework

Returns IMidwayFramework<IMidwayBaseApplication<CTX>, CTX, unknown, unknown, unknown>
- Defined in packages/core/src/interface.ts:900

getFrameworkType

getFrameworkType(): FrameworkType
Deprecated
Get current framework type in MidwayFrameworkType enum

Returns FrameworkType
- Defined in packages/core/src/interface.ts:906

getLogger

getLogger(name?: string): ILogger
Get default logger object or get the specified logger through parameters
Parameters
- Optional name: string
Returns ILogger
- Defined in packages/core/src/interface.ts:928

getMiddleware

getMiddleware<R, N>(): IMiddlewareManager<CTX, R, N>
get global middleware
Type Parameters
- R
- N
Returns IMiddlewareManager<CTX, R, N>
- Defined in packages/core/src/interface.ts:987

getNamespace

getNamespace(): string
get current namespace

Returns string
- Defined in packages/core/src/interface.ts:1004

getProcessType

getProcessType(): MidwayProcessTypeEnum
Get current running process type, app or agent, just for egg

Returns MidwayProcessTypeEnum
- Defined in packages/core/src/interface.ts:911

getProjectName

getProjectName(): string
Get project name, just package.json name

Returns string
- Defined in packages/core/src/interface.ts:945

setAttr

setAttr(key: string, value: any): any
Set value to app attribute map
Parameters
- key: string
- value: any
Returns any
- Defined in packages/core/src/interface.ts:970

setContextLoggerClass

setContextLoggerClass(BaseContextLoggerClass: any): void
Set a context logger class to change default context logger format
Parameters
- BaseContextLoggerClass: any
Returns void
- Defined in packages/core/src/interface.ts:957

useFilter

useFilter<R, N>(Filter: CommonFilterUnion<CTX, R, N>): void
add exception filter
Type Parameters
- R
- N
Parameters
- Filter: CommonFilterUnion<CTX, R, N>
Returns void
- Defined in packages/core/src/interface.ts:993

useGuard

useGuard(guard: CommonGuardUnion<CTX>): void
add global guard
Parameters
- guard: CommonGuardUnion<CTX>
Returns void
- Defined in packages/core/src/interface.ts:999

useMiddleware

useMiddleware<R, N>(Middleware: CommonMiddlewareUnion<CTX, R, N>): void
add global filter to app
Type Parameters
- R
- N
Parameters
- Middleware: CommonMiddlewareUnion<CTX, R, N>
Returns void
- Defined in packages/core/src/interface.ts:982

Generated using TypeDoc