Class BaseFramework<APP, CTX, OPT, ResOrNext, Next>`Abstract`

Type Parameters

APP extends IMidwayApplication<CTX>
CTX extends IMidwayContext
OPT extends IConfigurationOptions
ResOrNext = unknown
Next = unknown

Hierarchy

BaseFramework

Implements

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

Index

Constructors

Constructors

constructor

new BaseFramework<APP, CTX, OPT, ResOrNext, Next>(applicationContext: IMidwayContainer): BaseFramework<APP, CTX, OPT, ResOrNext, Next>
Type Parameters
- APP extends IMidwayBaseApplication<CTX, APP>
- CTX extends Context
- OPT extends IConfigurationOptions
- ResOrNext = unknown
- Next = unknown
Parameters
- applicationContext: IMidwayContainer
Returns BaseFramework<APP, CTX, OPT, ResOrNext, Next>
- Defined in packages/core/src/baseFramework.ts:85

Properties

app

app: APP

`Protected` appLogger

appLogger: ILogger

`Readonly` applicationContext

applicationContext: IMidwayContainer

`Protected` asyncContextManager

asyncContextManager: AsyncContextManager

`Protected` bootstrapOptions

bootstrapOptions: IMidwayBootstrapOptions

`Protected` composeMiddleware

composeMiddleware: any = null

configService

configService: MidwayConfigService

configurationOptions

configurationOptions: OPT

`Protected` contextLoggerApplyLogger

contextLoggerApplyLogger: string

`Protected` contextLoggerFormat

contextLoggerFormat: LoggerContextFormat

`Protected` defaultContext

defaultContext: {} = {}

Type declaration

environmentService

environmentService: MidwayEnvironmentService

`Protected` filterManager

filterManager: FilterManager<CTX, ResOrNext, Next> = ...

`Protected` guardManager

guardManager: GuardManager<CTX> = ...

informationService

informationService: MidwayInformationService

`Protected` logger

logger: ILogger

loggerService

loggerService: MidwayLoggerService

`Protected` middlewareManager

middlewareManager: ContextMiddlewareManager<CTX, ResOrNext, Next> = ...

middlewareService

middlewareService: MidwayMiddlewareService<CTX, ResOrNext, Next>

mockService

mockService: MidwayMockService

Methods

`Protected` afterContainerDirectoryLoad

afterContainerDirectoryLoad(options: Partial<IMidwayBootstrapOptions>): Promise<void>
Deprecated
Parameters
- options: Partial<IMidwayBootstrapOptions>
Returns Promise<void>
- Defined in packages/core/src/baseFramework.ts:358

`Protected` afterContainerInitialize

afterContainerInitialize(options: Partial<IMidwayBootstrapOptions>): Promise<void>
Deprecated
Parameters
- options: Partial<IMidwayBootstrapOptions>
Returns Promise<void>
- Defined in packages/core/src/baseFramework.ts:352

`Protected` afterContainerReady

afterContainerReady(options: Partial<IMidwayBootstrapOptions>): Promise<void>
Deprecated
Parameters
- options: Partial<IMidwayBootstrapOptions>
Returns Promise<void>
- Defined in packages/core/src/baseFramework.ts:364

`Abstract` applicationInitialize

applicationInitialize(options: IMidwayBootstrapOptions): any
Parameters
- options: IMidwayBootstrapOptions
Returns any
- Defined in packages/core/src/baseFramework.ts:155

applyMiddleware

applyMiddleware<R, N>(lastMiddleware?: CommonMiddlewareUnion<CTX, R, N>): Promise<MiddlewareRespond<CTX, R, N>>
Type Parameters
- R
- N
Parameters
- Optional lastMiddleware: CommonMiddlewareUnion<CTX, R, N>
Returns Promise<MiddlewareRespond<CTX, R, N>>
Implementation of IMidwayFramework.applyMiddleware
- Defined in packages/core/src/baseFramework.ts:368

`Protected` beforeContainerInitialize

beforeContainerInitialize(options: Partial<IMidwayBootstrapOptions>): Promise<void>
Deprecated
Parameters
- options: Partial<IMidwayBootstrapOptions>
Returns Promise<void>
- Defined in packages/core/src/baseFramework.ts:346

`Protected` beforeStop

beforeStop(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/baseFramework.ts:342

`Abstract` configure

configure(options?: OPT): any
Parameters
- Optional options: OPT
Returns any
Implementation of IMidwayFramework.configure
- Defined in packages/core/src/baseFramework.ts:98

`Protected` containerDirectoryLoad

containerDirectoryLoad(options: IMidwayBootstrapOptions): Promise<void>
Deprecated
Parameters
- options: IMidwayBootstrapOptions
Returns Promise<void>
- Defined in packages/core/src/baseFramework.ts:129

`Protected` containerInitialize

containerInitialize(options: IMidwayBootstrapOptions): Promise<void>
Deprecated
Parameters
- options: IMidwayBootstrapOptions
Returns Promise<void>
- Defined in packages/core/src/baseFramework.ts:125

`Protected` containerReady

containerReady(options: IMidwayBootstrapOptions): Promise<void>
Deprecated
Parameters
- options: IMidwayBootstrapOptions
Returns Promise<void>
- Defined in packages/core/src/baseFramework.ts:133

`Protected` createContextLogger

createContextLogger(ctx: CTX, name?: string): ILogger
Parameters
- ctx: CTX
- Optional name: string
Returns ILogger
- Defined in packages/core/src/baseFramework.ts:159

`Protected` createFilterManager

createFilterManager(): FilterManager<CTX, ResOrNext, Next>
Returns FilterManager<CTX, ResOrNext, Next>
- Defined in packages/core/src/baseFramework.ts:490

`Protected` createGuardManager

createGuardManager(): GuardManager<CTX>
Returns GuardManager<CTX>
- Defined in packages/core/src/baseFramework.ts:494

createLogger

createLogger(name: string, option?: LoggerOptions): any
Parameters
- name: string
- option: LoggerOptions = {}
Returns any
Implementation of IMidwayFramework.createLogger
- Defined in packages/core/src/baseFramework.ts:448

`Protected` createMiddlewareManager

createMiddlewareManager(): ContextMiddlewareManager<CTX, ResOrNext, Next>
Returns ContextMiddlewareManager<CTX, ResOrNext, Next>
- Defined in packages/core/src/baseFramework.ts:486

`Protected` defineApplicationProperties

defineApplicationProperties(applicationProperties?: {}, whiteList?: string[]): void
Parameters
- applicationProperties: {} = {}
- whiteList: string[] = []
Returns void
- Defined in packages/core/src/baseFramework.ts:214

getAppDir

getAppDir(): string
Returns string
Implementation of IMidwayFramework.getAppDir
- Defined in packages/core/src/baseFramework.ts:206

getApplication

getApplication(): APP
Returns APP
Implementation of IMidwayFramework.getApplication
- Defined in packages/core/src/baseFramework.ts:151

getApplicationContext

getApplicationContext(): IMidwayContainer
Returns IMidwayContainer
Implementation of IMidwayFramework.getApplicationContext
- Defined in packages/core/src/baseFramework.ts:139

getBaseDir

getBaseDir(): string
Returns string
Implementation of IMidwayFramework.getBaseDir
- Defined in packages/core/src/baseFramework.ts:210

getConfiguration

getConfiguration(key?: string): any
Parameters
- Optional key: string
Returns any
Implementation of IMidwayFramework.getConfiguration
- Defined in packages/core/src/baseFramework.ts:143

getCoreLogger

getCoreLogger(): ILogger
Returns ILogger
Implementation of IMidwayFramework.getCoreLogger
- Defined in packages/core/src/baseFramework.ts:444

getCurrentEnvironment

getCurrentEnvironment(): string
Returns string
Implementation of IMidwayFramework.getCurrentEnvironment
- Defined in packages/core/src/baseFramework.ts:147

getFrameworkName

getFrameworkName(): string
Returns string
Implementation of IMidwayFramework.getFrameworkName
- Defined in packages/core/src/baseFramework.ts:456

getLogger

getLogger(name?: string): any
Parameters
- Optional name: string
Returns any
Implementation of IMidwayFramework.getLogger
- Defined in packages/core/src/baseFramework.ts:440

getMiddleware

getMiddleware(): ContextMiddlewareManager<CTX, ResOrNext, Next>
Returns ContextMiddlewareManager<CTX, ResOrNext, Next>
Implementation of IMidwayFramework.getMiddleware
- Defined in packages/core/src/baseFramework.ts:466

getNamespace

getNamespace(): string
Returns string
Implementation of IMidwayFramework.getNamespace
- Defined in packages/core/src/baseFramework.ts:502

getProjectName

getProjectName(): string
Returns string
Implementation of IMidwayFramework.getProjectName
- Defined in packages/core/src/baseFramework.ts:452

init

init(): Promise<BaseFramework<APP, CTX, OPT, ResOrNext, Next>>
Returns Promise<BaseFramework<APP, CTX, OPT, ResOrNext, Next>>
- Defined in packages/core/src/baseFramework.ts:87

initialize

initialize(options?: IMidwayBootstrapOptions): Promise<void>
Parameters
- Optional options: IMidwayBootstrapOptions
Returns Promise<void>
Implementation of IMidwayFramework.initialize
- Defined in packages/core/src/baseFramework.ts:104

isEnable

isEnable(): boolean
Returns boolean
Implementation of IMidwayFramework.isEnable
- Defined in packages/core/src/baseFramework.ts:100

`Abstract` run

run(): Promise<void>
Returns Promise<void>
Implementation of IMidwayFramework.run
- Defined in packages/core/src/baseFramework.ts:157

runGuard

runGuard(ctx: CTX, supplierClz: (new (...args: any[]) => any), methodName: string): Promise<boolean>
Parameters
- ctx: CTX
- supplierClz: (new (...args: any[]) => any)
  - - new (...args: any[]): any
    - Parameters
      
      Rest ...args: any[]
      
      Returns any
- methodName: string
Returns Promise<boolean>
Implementation of IMidwayFramework.runGuard
- Defined in packages/core/src/baseFramework.ts:478

setNamespace

setNamespace(namespace: string): void
Parameters
- namespace: string
Returns void
Implementation of IMidwayFramework.setNamespace
- Defined in packages/core/src/baseFramework.ts:498

stop

stop(): Promise<void>
Returns Promise<void>
Implementation of IMidwayFramework.stop
- Defined in packages/core/src/baseFramework.ts:200

useFilter

useFilter(filter: CommonFilterUnion<CTX, ResOrNext, Next>): void
Parameters
- filter: CommonFilterUnion<CTX, ResOrNext, Next>
Returns void
Implementation of IMidwayFramework.useFilter
- Defined in packages/core/src/baseFramework.ts:470

useGuard

useGuard(guards: CommonGuardUnion<CTX>): void
Parameters
- guards: CommonGuardUnion<CTX>
Returns void
Implementation of IMidwayFramework.useGuard
- Defined in packages/core/src/baseFramework.ts:474

useMiddleware

useMiddleware(middleware: CommonMiddlewareUnion<CTX, ResOrNext, Next>): void
Parameters
- middleware: CommonMiddlewareUnion<CTX, ResOrNext, Next>
Returns void
Implementation of IMidwayFramework.useMiddleware
- Defined in packages/core/src/baseFramework.ts:460

Generated using TypeDoc