Configuration

This page is the configuration lookup for @kubemq/nestjs-transport — package and runtime facts, entry points, and every option interface for the server strategy, named clients, and the CQRS bridge. For the decorator, context, and export surface see the API reference; for the error catalog see error codes. For task-oriented setup, start with Getting Started.

Package & Entry Points

@kubemq/nestjs-transport is the KubeMQ transport for NestJS microservices. It wires all five KubeMQ messaging patterns — Commands, Queries, Events, Events Store, and Queues — into the NestJS ecosystem with custom decorators, a dynamic module, health checks, a CQRS bridge, pluggable serialization, and testing utilities. It is built on the native kubemq-js SDK with a TypeScript-first API and an ESM + CJS dual build.

The package exposes three entry points through its exports map:

# Core transport + runtime SDK
npm install @kubemq/nestjs-transport kubemq-js

# Peer dependencies (most ship with a typical NestJS project)
npm install @nestjs/common @nestjs/core @nestjs/microservices rxjs reflect-metadata

# Optional peers — only for the features that use them
npm install @nestjs/terminus   # health checks
npm install @nestjs/cqrs        # CQRS bridge

The main entry point re-exports the testing mocks for convenience, so MockKubeMQClient and MockKubeMQServer are importable from either @kubemq/nestjs-transport or @kubemq/nestjs-transport/testing.

KubeMQServerOptions

Configuration for the KubeMQServer transport strategy you pass to connectMicroservice. KubeMQModuleOptions is this interface plus an isGlobal flag. Only address is required.

KubeMQClientOptions

Configuration for a named KubeMQClientProxy created via register / registerAsync. It mirrors the server options for connection settings, and adds circuitBreaker, defaultQueuePolicy, and the internal channelPrefix set by forFeature.

CircuitBreakerOptions

QueueMessagePolicyOptions

KubeMQCqrsOptions

Configuration for KubeMQCqrsModule.forRoot from @kubemq/nestjs-transport/cqrs. The bridge routes @nestjs/cqrs CommandBus, QueryBus, and EventBus traffic through KubeMQ channels named {prefix}.{MessageName}.

import { Module } from '@nestjs/common';
import { CqrsModule } from '@nestjs/cqrs';
import { KubeMQModule } from '@kubemq/nestjs-transport';
import { KubeMQCqrsModule } from '@kubemq/nestjs-transport/cqrs';

@Module({
  imports: [
    KubeMQModule.forRoot({ address: 'localhost:50000' }),
    CqrsModule,
    KubeMQCqrsModule.forRoot({
      commandChannelPrefix: 'myapp.commands',
      queryChannelPrefix: 'myapp.queries',
      eventChannelPrefix: 'myapp.events',
      persistEvents: true,
      commandTimeout: 10,
      queryTimeout: 10,
    }),
  ],
})
export class AppModule {}

See Also