Class Framework

Hierarchy

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

Index

Constructors

Methods

applicationInitialize beforeStop configure generateController generateMiddleware getFrameworkName getFrameworkType getPort getServer loadMidwayController run useFilter useMiddleware

Constructors

constructor

new Framework(applicationContext: IMidwayContainer): Framework
Parameters
- applicationContext: IMidwayContainer
Returns Framework
Inherited from BaseFramework< IMidwayKoaApplication, IMidwayKoaContext, IMidwayKoaConfigurationOptions, Next >.constructor
- Defined in packages/core/dist/baseFramework.d.ts:35

Methods

applicationInitialize

applicationInitialize(options: Partial<IMidwayBootstrapOptions>): Promise<void>
Parameters
- options: Partial<IMidwayBootstrapOptions>
Returns Promise<void>
Overrides BaseFramework.applicationInitialize
- Defined in packages/web-koa/src/framework.ts:63

beforeStop

beforeStop(): Promise<void>
Returns Promise<void>
Overrides BaseFramework.beforeStop
- Defined in packages/web-koa/src/framework.ts:239

configure

configure(): IMidwayKoaConfigurationOptions
Returns IMidwayKoaConfigurationOptions
Overrides BaseFramework.configure
- Defined in packages/web-koa/src/framework.ts:59

generateController

generateController(routeInfo: RouterInfo): Middleware<DefaultState, IMidwayKoaContext, any>
wrap controller string to middleware function
Parameters
- routeInfo: RouterInfo
Returns Middleware<DefaultState, IMidwayKoaContext, any>
- Defined in packages/web-koa/src/framework.ts:160

generateMiddleware

generateMiddleware(middlewareId: any): Promise<Middleware<DefaultState, IMidwayKoaContext, any>>
Deprecated
Parameters
- middlewareId: any
Returns Promise<Middleware<DefaultState, IMidwayKoaContext, any>>
- Defined in packages/web-koa/src/framework.ts:170

getFrameworkName

getFrameworkName(): string
Returns string
Overrides BaseFramework.getFrameworkName
- Defined in packages/web-koa/src/framework.ts:251

getFrameworkType

getFrameworkType(): MidwayFrameworkType
Returns MidwayFrameworkType
- Defined in packages/web-koa/src/framework.ts:247

getPort

getPort(): string
Returns string
- Defined in packages/web-koa/src/framework.ts:259

getServer

getServer(): Server<typeof IncomingMessage, typeof ServerResponse>
Returns Server<typeof IncomingMessage, typeof ServerResponse>
- Defined in packages/web-koa/src/framework.ts:255

loadMidwayController

loadMidwayController(): Promise<void>
Returns Promise<void>
- Defined in packages/web-koa/src/framework.ts:149

run

run(): Promise<void>
Returns Promise<void>
Overrides BaseFramework.run
- Defined in packages/web-koa/src/framework.ts:177

useFilter

useFilter(Filter: CommonFilterUnion<IMidwayKoaContext, Next, unknown>): void
Parameters
- Filter: CommonFilterUnion<IMidwayKoaContext, Next, unknown>
Returns void
Overrides BaseFramework.useFilter
- Defined in packages/web-koa/src/framework.ts:269

useMiddleware

useMiddleware(Middleware: CommonMiddlewareUnion<IMidwayKoaContext, Next, unknown>): void
Parameters
- Middleware: CommonMiddlewareUnion<IMidwayKoaContext, Next, unknown>
Returns void
Overrides BaseFramework.useMiddleware
- Defined in packages/web-koa/src/framework.ts:263

Generated using TypeDoc