Framework

Hierarchy

• BaseFramework<IMidwayKoaApplication, IMidwayKoaContext, IMidwayKoaConfigurationOptions, Next>
  • Framework

Index

Constructors

• constructor

Properties

• app
• applicationContext
• configService
• configurationOptions
• environmentService
• informationService
• loggerService
• middlewareService
• mockService

Methods

• applicationInitialize
• applyMiddleware
• beforeStop
• configure
• createLogger
• generateController
• generateMiddleware
• getAppDir
• getApplication
• getApplicationContext
• getBaseDir
• getConfiguration
• getCoreLogger
• getCurrentEnvironment
• getFrameworkName
• getFrameworkType
• getLogger
• getMiddleware
• getNamespace
• getPort
• getProjectName
• getServer
• init
• initialize
• isEnable
• loadMidwayController
• run
• runGuard
• setNamespace
• stop
• useFilter
• useGuard
• useMiddleware

Constructors

constructor

• new Framework(applicationContext: IMidwayContainer): MidwayKoaFramework

• Inherited from BaseFramework< IMidwayKoaApplication, IMidwayKoaContext, IMidwayKoaConfigurationOptions, Next >.constructor

Properties

app

app: IMidwayKoaApplication

Inherited from BaseFramework.app

readonlyapplicationContext

applicationContext: IMidwayContainer

Inherited from BaseFramework.applicationContext

configService

configService: MidwayConfigService

Inherited from BaseFramework.configService

configurationOptions

configurationOptions: IMidwayKoaConfigurationOptions

Inherited from BaseFramework.configurationOptions

environmentService

environmentService: MidwayEnvironmentService

Inherited from BaseFramework.environmentService

informationService

informationService: MidwayInformationService

Inherited from BaseFramework.informationService

loggerService

loggerService: MidwayLoggerService

Inherited from BaseFramework.loggerService

middlewareService

middlewareService: MidwayMiddlewareService<IMidwayKoaContext, Next, unknown>

Inherited from BaseFramework.middlewareService

mockService

mockService: MidwayMockService

Inherited from BaseFramework.mockService

Methods

applicationInitialize

• applicationInitialize(options: Partial<IMidwayBootstrapOptions>): Promise<void>

• Overrides BaseFramework.applicationInitialize

applyMiddleware

• applyMiddleware<R, N>(lastMiddleware?: CommonMiddlewareUnion<IMidwayKoaContext, R, N>): Promise<MiddlewareRespond<IMidwayKoaContext, R, N>>

• Inherited from BaseFramework.applyMiddleware

  Type parameters

  • R
  • N

publicbeforeStop

• beforeStop(): Promise<void>

• Overrides BaseFramework.beforeStop

configure

• configure(): IMidwayKoaConfigurationOptions

• Overrides BaseFramework.configure

createLogger

• createLogger(name: string, option?: MidwayLoggerOptions): any

• Inherited from BaseFramework.createLogger

publicgenerateController

• generateController(routeInfo: RouterInfo): Middleware<DefaultState, IMidwayKoaContext, any>

• wrap controller string to middleware function

publicgenerateMiddleware

• generateMiddleware(middlewareId: any): Promise<Middleware<DefaultState, IMidwayKoaContext, any>>

• @deprecated

getAppDir

• getAppDir(): string

• Inherited from BaseFramework.getAppDir

getApplication

• getApplication(): IMidwayKoaApplication

• Inherited from BaseFramework.getApplication

getApplicationContext

• getApplicationContext(): IMidwayContainer

• Inherited from BaseFramework.getApplicationContext

getBaseDir

• getBaseDir(): string

• Inherited from BaseFramework.getBaseDir

getConfiguration

• getConfiguration(key?: string): any

• Inherited from BaseFramework.getConfiguration

getCoreLogger

• getCoreLogger(): ILogger

• Inherited from BaseFramework.getCoreLogger

getCurrentEnvironment

• getCurrentEnvironment(): string

• Inherited from BaseFramework.getCurrentEnvironment

publicgetFrameworkName

• getFrameworkName(): string

• Overrides BaseFramework.getFrameworkName

publicgetFrameworkType

• getFrameworkType(): MidwayFrameworkType

getLogger

• getLogger(name?: string): any

• Inherited from BaseFramework.getLogger

getMiddleware

• getMiddleware(): ContextMiddlewareManager<IMidwayKoaContext, Next, unknown>

• Inherited from BaseFramework.getMiddleware

getNamespace

• getNamespace(): string

• Inherited from BaseFramework.getNamespace

publicgetPort

• getPort(): string

getProjectName

• getProjectName(): string

• Inherited from BaseFramework.getProjectName

publicgetServer

• getServer(): Server<typeof IncomingMessage, typeof ServerResponse>

init

• init(): Promise<MidwayKoaFramework>

• Inherited from BaseFramework.init

initialize

• initialize(options?: IMidwayBootstrapOptions): Promise<void>

• Inherited from BaseFramework.initialize

isEnable

• isEnable(): boolean

• Inherited from BaseFramework.isEnable

loadMidwayController

• loadMidwayController(): Promise<void>

publicrun

• run(): Promise<void>

• Overrides BaseFramework.run

runGuard

• runGuard(ctx: IMidwayKoaContext, supplierClz: new (...args: any[]) => any, methodName: string): Promise<boolean>

• Inherited from BaseFramework.runGuard

setNamespace

• setNamespace(namespace: string): void

• Inherited from BaseFramework.setNamespace

stop

• stop(): Promise<void>

• Inherited from BaseFramework.stop

publicuseFilter

• useFilter(Filter: CommonFilterUnion<IMidwayKoaContext, Next, unknown>): void

• Overrides BaseFramework.useFilter

useGuard

• useGuard(guards: CommonGuardUnion<IMidwayKoaContext>): void

• Inherited from BaseFramework.useGuard

publicuseMiddleware

• useMiddleware(Middleware: CommonMiddlewareUnion<IMidwayKoaContext, Next, unknown>): void

• Overrides BaseFramework.useMiddleware