Framework

Hierarchy

• BaseFramework<any, IMidwayKafkaContext, any>
  • Framework

Index

Constructors

• constructor

Properties

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

Methods

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

Constructors

constructor

• new Framework(applicationContext: IMidwayContainer): MidwayKafkaFramework

• Inherited from BaseFramework< any, IMidwayKafkaContext, any >.constructor

Properties

app

app: any

Inherited from BaseFramework.app

readonlyapplicationContext

applicationContext: IMidwayContainer

Inherited from BaseFramework.applicationContext

configService

configService: MidwayConfigService

Inherited from BaseFramework.configService

configurationOptions

configurationOptions: any

Inherited from BaseFramework.configurationOptions

environmentService

environmentService: MidwayEnvironmentService

Inherited from BaseFramework.environmentService

informationService

informationService: MidwayInformationService

Inherited from BaseFramework.informationService

kafKaLogger

kafKaLogger: ILogger

loggerService

loggerService: MidwayLoggerService

Inherited from BaseFramework.loggerService

middlewareService

middlewareService: MidwayMiddlewareService<IMidwayKafkaContext, unknown, unknown>

Inherited from BaseFramework.middlewareService

mockService

mockService: MidwayMockService

Inherited from BaseFramework.mockService

Methods

applicationInitialize

• applicationInitialize(): Promise<void>

• Overrides BaseFramework.applicationInitialize

applyMiddleware

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

• Inherited from BaseFramework.applyMiddleware

  Type parameters

  • R
  • N

configure

• configure(): any

• Overrides BaseFramework.configure

createLogger

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

• Inherited from BaseFramework.createLogger

getAppDir

• getAppDir(): string

• Inherited from BaseFramework.getAppDir

getApplication

• getApplication(): any

• 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

publicgetConsumer

• getConsumer(subscriberNameOrInstanceName: string): any

getCoreLogger

• getCoreLogger(): ILogger

• Inherited from BaseFramework.getCoreLogger

getCurrentEnvironment

• getCurrentEnvironment(): string

• Inherited from BaseFramework.getCurrentEnvironment

publicgetFrameworkName

• getFrameworkName(): string

• Overrides BaseFramework.getFrameworkName

publicgetFrameworkType

• getFrameworkType(): MidwayFrameworkType

publicgetKafka

• getKafka(instanceName: string): Kafka

getLogger

• getLogger(name?: string): any

• Inherited from BaseFramework.getLogger

getMiddleware

• getMiddleware(): ContextMiddlewareManager<IMidwayKafkaContext, unknown, unknown>

• Inherited from BaseFramework.getMiddleware

getNamespace

• getNamespace(): string

• Inherited from BaseFramework.getNamespace

getProjectName

• getProjectName(): string

• Inherited from BaseFramework.getProjectName

init

• init(): Promise<MidwayKafkaFramework>

• Inherited from BaseFramework.init

initialize

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

• Inherited from BaseFramework.initialize

isEnable

• isEnable(): boolean

• Inherited from BaseFramework.isEnable

publicrun

• run(): Promise<void>

• Overrides BaseFramework.run

runGuard

• runGuard(ctx: IMidwayKafkaContext, 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

useFilter

• useFilter(filter: CommonFilterUnion<IMidwayKafkaContext, unknown, unknown>): void

• Inherited from BaseFramework.useFilter

useGuard

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

• Inherited from BaseFramework.useGuard

useMiddleware

• useMiddleware(middleware: CommonMiddlewareUnion<IMidwayKafkaContext, unknown, unknown>): void

• Inherited from BaseFramework.useMiddleware