abstractBaseFramework <APP, CTX, OPT, ResOrNext, Next>

Implements

• IMidwayFramework<APP, CTX, OPT, ResOrNext, Next>

Index

Constructors

• constructor

Properties

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

Methods

• applicationInitialize
• applyMiddleware
• configure
• createLogger
• getAppDir
• getApplication
• getApplicationContext
• getBaseDir
• getConfiguration
• getCoreLogger
• getCurrentEnvironment
• getFrameworkName
• getLogger
• getMiddleware
• getNamespace
• getProjectName
• init
• initialize
• isEnable
• run
• runGuard
• setNamespace
• stop
• useFilter
• useGuard
• useMiddleware

Constructors

constructor

• new BaseFramework<APP, CTX, OPT, ResOrNext, Next>(applicationContext: IMidwayContainer): BaseFramework<APP, CTX, OPT, ResOrNext, Next>

• Type parameters

  • APP: IMidwayBaseApplication<CTX, APP>
  • CTX: Context
  • OPT: IConfigurationOptions
  • ResOrNext = unknown
  • Next = unknown

Properties

publicapp

app: APP

Implementation of IMidwayFramework.app

readonlyapplicationContext

applicationContext: IMidwayContainer

configService

configService: MidwayConfigService

publicconfigurationOptions

configurationOptions: OPT

Implementation of IMidwayFramework.configurationOptions

environmentService

environmentService: MidwayEnvironmentService

informationService

informationService: MidwayInformationService

loggerService

loggerService: MidwayLoggerService

middlewareService

middlewareService: MidwayMiddlewareService<CTX, ResOrNext, Next>

mockService

mockService: MidwayMockService

Methods

publicabstractapplicationInitialize

• applicationInitialize(options: IMidwayBootstrapOptions): any

publicapplyMiddleware

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

• Implementation of IMidwayFramework.applyMiddleware

  Type parameters

  • R
  • N

abstractconfigure

• configure(options?: OPT): any

• Implementation of IMidwayFramework.configure

publiccreateLogger

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

• Implementation of IMidwayFramework.createLogger

publicgetAppDir

• getAppDir(): string

• Implementation of IMidwayFramework.getAppDir

publicgetApplication

• getApplication(): APP

• Implementation of IMidwayFramework.getApplication

publicgetApplicationContext

• getApplicationContext(): IMidwayContainer

• Implementation of IMidwayFramework.getApplicationContext

publicgetBaseDir

• getBaseDir(): string

• Implementation of IMidwayFramework.getBaseDir

publicgetConfiguration

• getConfiguration(key?: string): any

• Implementation of IMidwayFramework.getConfiguration

publicgetCoreLogger

• getCoreLogger(): ILogger

• Implementation of IMidwayFramework.getCoreLogger

publicgetCurrentEnvironment

• getCurrentEnvironment(): string

• Implementation of IMidwayFramework.getCurrentEnvironment

publicgetFrameworkName

• getFrameworkName(): string

• Implementation of IMidwayFramework.getFrameworkName

publicgetLogger

• getLogger(name?: string): any

• Implementation of IMidwayFramework.getLogger

publicgetMiddleware

• getMiddleware(): ContextMiddlewareManager<CTX, ResOrNext, Next>

• Implementation of IMidwayFramework.getMiddleware

publicgetNamespace

• getNamespace(): string

• Implementation of IMidwayFramework.getNamespace

publicgetProjectName

• getProjectName(): string

• Implementation of IMidwayFramework.getProjectName

init

• init(): Promise<BaseFramework<APP, CTX, OPT, ResOrNext, Next>>

publicinitialize

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

• Implementation of IMidwayFramework.initialize

isEnable

• isEnable(): boolean

• Implementation of IMidwayFramework.isEnable

publicabstractrun

• run(): Promise<void>

• Implementation of IMidwayFramework.run

publicrunGuard

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

• Implementation of IMidwayFramework.runGuard

publicsetNamespace

• setNamespace(namespace: string): void

• Implementation of IMidwayFramework.setNamespace

publicstop

• stop(): Promise<void>

• Implementation of IMidwayFramework.stop

publicuseFilter

• useFilter(filter: CommonFilterUnion<CTX, ResOrNext, Next>): void

• Implementation of IMidwayFramework.useFilter

publicuseGuard

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

• Implementation of IMidwayFramework.useGuard

publicuseMiddleware

• useMiddleware(middleware: CommonMiddlewareUnion<CTX, ResOrNext, Next>): void

• Implementation of IMidwayFramework.useMiddleware