@moleculer/channels/types/src/index.d.ts

Reliable messages for Moleculer services

declare namespace _exports {
    export { ServiceBroker, Logger, Service, Middleware, BaseAdapter, DeadLetteringOptions, Channel, ChannelRegistryEntry, AdapterConfig, MiddlewareOptions };
}
declare function _exports(mwOpts: MiddlewareOptions): {
    name: string;
    /**
     * Create lifecycle hook of service
     * @param {ServiceBroker} _broker
     */
    created(_broker: ServiceBroker): void;
    /**
     * Created lifecycle hook of service
     *
     * @param {Service} svc
     */
    serviceCreated(svc: Service): Promise<void>;
    /**
     * Service stopping lifecycle hook.
     * Need to unsubscribe from the channels.
     *
     * @param {Service} svc
     */
    serviceStopping(svc: Service): Promise<void>;
    /**
     * Start lifecycle hook of service
     */
    started(): Promise<void>;
    /**
     * Stop lifecycle hook of service
     */
    stopped(): Promise<void>;
};
export = _exports;
/**
 * Moleculer Service Broker instance
 */
type ServiceBroker = import("moleculer").ServiceBroker;
/**
 * Logger instance
 */
type Logger = import("moleculer").LoggerInstance;
/**
 * Moleculer service
 */
type Service = import("moleculer").Service;
/**
 * Moleculer middleware
 */
type Middleware = import("moleculer").Middleware;
/**
 * Base adapter class
 */
type BaseAdapter = import("./adapters/base");
/**
 * Dead-letter-queue options
 */
type DeadLetteringOptions = {
    /**
     * Enable dead-letter-queue
     */
    enabled: boolean;
    /**
     * Name of the dead-letter queue
     */
    queueName: string;
    /**
     * Name of the dead-letter exchange (only for AMQP adapter)
     */
    exchangeName: string;
    /**
     * Options for the dead-letter exchange (only for AMQP adapter)
     */
    exchangeOptions: any;
    /**
     * Options for the dead-letter queue (only for AMQP adapter)
     */
    queueOptions: any;
};
/**
 * Base consumer configuration
 */
type Channel = {
    /**
     * Consumer ID
     */
    id: string;
    /**
     * Channel/Queue/Stream name
     */
    name: string;
    /**
     * Consumer group name
     */
    group: string;
    /**
     * Create Moleculer Context
     */
    context: boolean;
    /**
     * Flag denoting if service is stopping
     */
    unsubscribing: boolean;
    /**
     * Maximum number of messages that can be processed simultaneously
     */
    maxInFlight: number | null;
    /**
     * Maximum number of retries before sending the message to dead-letter-queue
     */
    maxRetries: number;
    /**
     * Dead-letter-queue options
     */
    deadLettering: DeadLetteringOptions | null;
    /**
     * User defined handler
     */
    handler: Function;
};
/**
 * Registry entry
 */
type ChannelRegistryEntry = {
    /**
     * Service instance class
     */
    svc: Service;
    /**
     * Channel name
     */
    name: string;
    /**
     * Channel object
     */
    chan: Channel;
};
type AdapterConfig = {
    /**
     * Adapter name
     */
    type: string;
    /**
     * Adapter options
     */
    options: import("./adapters/base").BaseDefaultOptions & import("./adapters/amqp").AmqpDefaultOptions & import("./adapters/kafka").KafkaDefaultOptions & import("./adapters/nats").NatsDefaultOptions & import("./adapters/redis").RedisDefaultOptions;
};
/**
 * Middleware options
 */
type MiddlewareOptions = {
    /**
     * Adapter name or connection string or configuration object.
     */
    adapter: string | AdapterConfig;
    /**
     * Property name of channels definition in service schema.
     */
    schemaProperty: string | null;
    /**
     * Method name to send messages.
     */
    sendMethodName: string | null;
    /**
     * Property name of the adapter instance in broker instance.
     */
    adapterPropertyName: string | null;
    /**
     * Method name to add to service in order to trigger channel handlers.
     */
    channelHandlerTrigger: string | null;
    /**
     * Using Moleculer context in channel handlers by default.
     */
    context: boolean | null;
};