OpraKafkaModule

NestJS dynamic module that wires OPRA's Kafka adapter into a NestJS application.

import { OpraKafkaModule } from '@opra/nestjs-kafka';

---

forRoot(options)

Synchronous registration:

import { Module } from '@nestjs/common';
import { OpraKafkaModule } from '@opra/nestjs-kafka';
import { OrderController } from './controllers/order.controller.js';

@Module({
  imports: [
    OpraKafkaModule.forRoot({
      name: 'OrdersApi',
      client: {
        brokers: ['localhost:9092'],
      },
      consumers: [
        { groupId: 'orders-group' },
      ],
      controllers: [OrderController],
    }),
  ],
})
export class AppModule {}

Options (OpraKafkaModule.ModuleOptions)

Option	Type	Description
name	string	API name.
description	string	Optional API description.
scope	string	Validation scope.
client	KafkaAdapter.Config['client']	Kafka client configuration (brokers, SSL, SASL…).
consumers	KafkaAdapter.Config['consumers']	Consumer group configuration.
logExtra	KafkaAdapter.Config['logExtra']	Extra log context.
defaults	KafkaAdapter.Config['defaults']	Default consumer/producer settings.
types	Type[]	Data types to register on the ApiDocument.
references	object	Type references.
info	object	API info metadata.
controllers	Type[]	OPRA MQ controller classes.
providers	Provider[]	Additional NestJS providers.
exports	any[]	Providers to export.
imports	any[]	Modules to import.
global	boolean	Register globally.
id	any	Custom module ID.
interceptors	(InterceptorFunction | IKafkaInterceptor | Type<IKafkaInterceptor>)[]	Request interceptors.
logger	Logger	Custom logger.

---

forRootAsync(options)

Asynchronous registration:

OpraKafkaModule.forRootAsync({
  imports: [ConfigModule],
  inject: [ConfigService],
  useFactory: (config: ConfigService) => ({
    name: 'OrdersApi',
    client: { brokers: config.get('KAFKA_BROKERS').split(',') },
    consumers: [{ groupId: config.get('KAFKA_GROUP_ID') }],
    controllers: [OrderController],
  }),
})

Options (OpraKafkaModule.AsyncModuleOptions)

Option	Type	Description
inject	any[]	Providers to inject into useFactory.
useFactory	(...args) => ApiConfig | Promise<ApiConfig>	Factory returning the API configuration.

Plus all non-API fields from ModuleOptions (id, controllers, providers, exports, imports, global, interceptors).