Class KafkaInAsync<INTERNALIN, INTERNALRETURN, INTERNALOUT, EXTERNALOUT>Abstract

Represents an asynchronous Kafka route with specific input and output types.

Example


import { KafkaInAsync } from '@modules/starter';
import { FastifyInstance } from 'fastify';

export class MyKafkaRoute extends KafkaInAsync<string, string, string, string> {
 ID = 'MyKafkaRoute';
 TYPE = ROUTETYPE.KAFKA;
 topic = 'my-topic';
 outTopic = 'my-out-topic';

Type Parameters

  • INTERNALIN

    The type of the input data consumed by the route.

  • INTERNALRETURN

    The type of the data returned by the consume function.

  • INTERNALOUT

    The type of the data processed by the process function.

  • EXTERNALOUT

    The type of the data produced by the produce function.

Implements

Constructors

constructor

Properties

DESCRIPTION? ID outTopic topic TYPE

Methods

consume initialize process produce

Constructors

constructor

Properties

OptionalDESCRIPTION

DESCRIPTION?: string

A description of the route.

AbstractID

ID: string

The unique identifier for the route.

AbstractoutTopic

outTopic: string

The Kafka topic to produce messages to.

Abstracttopic

topic: string

The Kafka topic to consume messages from.

AbstractTYPE

TYPE: ROUTETYPE

The type of the route, defined by the ROUTETYPE enum.

Methods

Abstractconsume

initialize

  • initialize(
        app: FastifyInstance<
            RawServerDefault,
            IncomingMessage,
            ServerResponse<IncomingMessage>,
            FastifyBaseLogger,
            FastifyTypeProviderDefault,
        >,
    ): Promise<void>

  • Initializes the route.

    Parameters

    • app: FastifyInstance<
          RawServerDefault,
          IncomingMessage,
          ServerResponse<IncomingMessage>,
          FastifyBaseLogger,
          FastifyTypeProviderDefault,
      >

    Returns Promise<void>

Abstractprocess

Abstractproduce

Settings

Member Visibility

On This Page

Constructors
Properties
Methods