NestJS Slack Integration
    Preparing search index...

    Hierarchy (View Summary)

    Implements

    • CustomTransportStrategy
    Index

    Constructors

    Properties

    _status$: ReplaySubject<string>
    deserializer: ConsumerDeserializer
    logger: LoggerService
    messageHandlers: Map<string, MessageHandler<any, any, any>>
    options: SlackOptions
    serializer: ConsumerSerializer
    transportId?: symbol | Transport

    Unique transport identifier.

    Accessors

    • get status(): Observable<Status>

      Returns an observable that emits status changes.

      Returns Observable<Status>

    Methods

    • Parameters

      • pattern: any
      • callback: MessageHandler
      • OptionalisEventHandler: boolean
      • Optionalextras: Record<string, any>

      Returns void

    • Method called when server is being terminated.

      Returns Promise<void>

    • Parameters

      • pattern: string

      Returns null | MessageHandler<any, any, any>

    • Returns Map<string, MessageHandler<any, any, any>>

    • Type Parameters

      • Options extends
            | undefined
            | Record<string, any>
            | {
                channelOptions?: ChannelOptions;
                credentials?: any;
                gracefulShutdown?: boolean;
                keepalive?: {
                    http2MaxPingStrikes?: number;
                    http2MaxPingsWithoutData?: number;
                    http2MinPingIntervalWithoutDataMs?: number;
                    http2MinTimeBetweenPingsMs?: number;
                    keepalivePermitWithoutCalls?: number;
                    keepaliveTimeMs?: number;
                    keepaliveTimeoutMs?: number;
                };
                loader?: {
                    alternateCommentMode?: boolean;
                    arrays?: boolean;
                    bytes?: Function;
                    defaults?: boolean;
                    enums?: Function;
                    includeDirs?: string[];
                    json?: boolean;
                    keepCase?: boolean;
                    longs?: Function;
                    objects?: boolean;
                    oneofs?: boolean;
                };
                maxMetadataSize?: number;
                maxReceiveMessageLength?: number;
                maxSendMessageLength?: number;
                onLoadPackageDefinition?: (pkg: any, server: any) => void;
                package: string | string[];
                packageDefinition?: any;
                protoLoader?: string;
                protoPath?: string | string[];
                url?: string;
            }
            | {
                deserializer?: Deserializer<any, any>;
                host?: string;
                port?: number;
                retryAttempts?: number;
                retryDelay?: number;
                serializer?: Serializer<any, any>;
                socketClass?: Type<TcpSocket>;
                tlsOptions?: TlsOptions;
            }
            | {
                deserializer?: Deserializer<any, any>;
                host?: string;
                port?: number;
                retryAttempts?: number;
                retryDelay?: number;
                serializer?: Serializer<any, any>;
                wildcards?: boolean;
            } & IORedisOptions
            | {
                authenticator?: any;
                debug?: boolean;
                deserializer?: Deserializer<any, any>;
                encoding?: string;
                gracefulShutdown?: boolean;
                gracePeriod?: number;
                headers?: Record<string, string>;
                ignoreClusterUpdates?: boolean;
                inboxPrefix?: string;
                maxPingOut?: number;
                maxReconnectAttempts?: number;
                name?: string;
                nkey?: any;
                noEcho?: boolean;
                nonceSigner?: any;
                noRandomize?: boolean;
                pass?: string;
                pedantic?: boolean;
                pingInterval?: number;
                preserveBuffers?: boolean;
                queue?: string;
                reconnect?: boolean;
                reconnectDelayHandler?: any;
                reconnectJitter?: number;
                reconnectJitterTLS?: number;
                reconnectTimeWait?: number;
                serializer?: Serializer<any, any>;
                servers?: string | string[];
                timeout?: number;
                tls?: any;
                token?: string;
                tokenHandler?: any;
                useOldRequestStyle?: boolean;
                user?: string;
                userCreds?: any;
                userJWT?: string;
                verbose?: boolean;
                waitOnFirstConnect?: boolean;
                yieldTime?: number;
                [key: string]: any;
            }
            | MqttClientOptions & {
                deserializer?: Deserializer<any, any>;
                serializer?: Serializer<any, any>;
                subscribeOptions?: { nl?: boolean; qos: QoS; rap?: boolean; rh?: number };
                url?: string;
                userProperties?: Record<string, string | string[]>;
            }
            | {
                consumerTag?: string;
                deserializer?: Deserializer<any, any>;
                exchange?: string;
                headers?: Record<string, string>;
                isGlobalPrefetchCount?: boolean;
                maxConnectionAttempts?: number;
                noAck?: boolean;
                noAssert?: boolean;
                persistent?: boolean;
                prefetchCount?: number;
                queue?: string;
                queueOptions?: AmqplibQueueOptions;
                replyQueue?: string;
                routingKey?: string;
                serializer?: Serializer<any, any>;
                socketOptions?: AmqpConnectionManagerSocketOptions;
                urls?: string[] | RmqUrl[];
            }
            | {
                client?: KafkaConfig;
                consumer?: ConsumerConfig;
                deserializer?: Deserializer<any, any>;
                parser?: KafkaParserConfig;
                postfixId?: string;
                producer?: ProducerConfig;
                producerOnlyMode?: boolean;
                run?: Omit<ConsumerRunConfig, "eachBatch" | "eachMessage">;
                send?: Omit<ProducerRecord, "messages" | "topic">;
                serializer?: Serializer<any, any>;
                subscribe?: Omit<ConsumerSubscribeTopics, "topics">;
            }
      • Attribute extends string | number | symbol

      Parameters

      Returns Options[Attribute]

    • Type Parameters

      • Options extends
            | undefined
            | Record<string, any>
            | {
                channelOptions?: ChannelOptions;
                credentials?: any;
                gracefulShutdown?: boolean;
                keepalive?: {
                    http2MaxPingStrikes?: number;
                    http2MaxPingsWithoutData?: number;
                    http2MinPingIntervalWithoutDataMs?: number;
                    http2MinTimeBetweenPingsMs?: number;
                    keepalivePermitWithoutCalls?: number;
                    keepaliveTimeMs?: number;
                    keepaliveTimeoutMs?: number;
                };
                loader?: {
                    alternateCommentMode?: boolean;
                    arrays?: boolean;
                    bytes?: Function;
                    defaults?: boolean;
                    enums?: Function;
                    includeDirs?: string[];
                    json?: boolean;
                    keepCase?: boolean;
                    longs?: Function;
                    objects?: boolean;
                    oneofs?: boolean;
                };
                maxMetadataSize?: number;
                maxReceiveMessageLength?: number;
                maxSendMessageLength?: number;
                onLoadPackageDefinition?: (pkg: any, server: any) => void;
                package: string | string[];
                packageDefinition?: any;
                protoLoader?: string;
                protoPath?: string | string[];
                url?: string;
            }
            | {
                deserializer?: Deserializer<any, any>;
                host?: string;
                port?: number;
                retryAttempts?: number;
                retryDelay?: number;
                serializer?: Serializer<any, any>;
                socketClass?: Type<TcpSocket>;
                tlsOptions?: TlsOptions;
            }
            | {
                deserializer?: Deserializer<any, any>;
                host?: string;
                port?: number;
                retryAttempts?: number;
                retryDelay?: number;
                serializer?: Serializer<any, any>;
                wildcards?: boolean;
            } & IORedisOptions
            | {
                authenticator?: any;
                debug?: boolean;
                deserializer?: Deserializer<any, any>;
                encoding?: string;
                gracefulShutdown?: boolean;
                gracePeriod?: number;
                headers?: Record<string, string>;
                ignoreClusterUpdates?: boolean;
                inboxPrefix?: string;
                maxPingOut?: number;
                maxReconnectAttempts?: number;
                name?: string;
                nkey?: any;
                noEcho?: boolean;
                nonceSigner?: any;
                noRandomize?: boolean;
                pass?: string;
                pedantic?: boolean;
                pingInterval?: number;
                preserveBuffers?: boolean;
                queue?: string;
                reconnect?: boolean;
                reconnectDelayHandler?: any;
                reconnectJitter?: number;
                reconnectJitterTLS?: number;
                reconnectTimeWait?: number;
                serializer?: Serializer<any, any>;
                servers?: string | string[];
                timeout?: number;
                tls?: any;
                token?: string;
                tokenHandler?: any;
                useOldRequestStyle?: boolean;
                user?: string;
                userCreds?: any;
                userJWT?: string;
                verbose?: boolean;
                waitOnFirstConnect?: boolean;
                yieldTime?: number;
                [key: string]: any;
            }
            | MqttClientOptions & {
                deserializer?: Deserializer<any, any>;
                serializer?: Serializer<any, any>;
                subscribeOptions?: { nl?: boolean; qos: QoS; rap?: boolean; rh?: number };
                url?: string;
                userProperties?: Record<string, string | string[]>;
            }
            | {
                consumerTag?: string;
                deserializer?: Deserializer<any, any>;
                exchange?: string;
                headers?: Record<string, string>;
                isGlobalPrefetchCount?: boolean;
                maxConnectionAttempts?: number;
                noAck?: boolean;
                noAssert?: boolean;
                persistent?: boolean;
                prefetchCount?: number;
                queue?: string;
                queueOptions?: AmqplibQueueOptions;
                replyQueue?: string;
                routingKey?: string;
                serializer?: Serializer<any, any>;
                socketOptions?: AmqpConnectionManagerSocketOptions;
                urls?: string[] | RmqUrl[];
            }
            | {
                client?: KafkaConfig;
                consumer?: ConsumerConfig;
                deserializer?: Deserializer<any, any>;
                parser?: KafkaParserConfig;
                postfixId?: string;
                producer?: ProducerConfig;
                producerOnlyMode?: boolean;
                run?: Omit<ConsumerRunConfig, "eachBatch" | "eachMessage">;
                send?: Omit<ProducerRecord, "messages" | "topic">;
                serializer?: Serializer<any, any>;
                subscribe?: Omit<ConsumerSubscribeTopics, "topics">;
            }
      • Attribute extends string | number | symbol
      • DefaultValue = Options[Attribute]

      Parameters

      Returns Required<Options>[Attribute]

    • Transforms the server Pattern to valid type and returns a route for him.

      Parameters

      • pattern: string

        server pattern

      Returns string

      string

    • Parameters

      • error: string

      Returns void

    • Parameters

      • pattern: string
      • packet: ReadPacket
      • context: BaseRpcContext

      Returns Promise<any>

    • Parameters

      • options:
            | undefined
            | {
                channelOptions?: ChannelOptions;
                credentials?: any;
                gracefulShutdown?: boolean;
                keepalive?: {
                    http2MaxPingStrikes?: number;
                    http2MaxPingsWithoutData?: number;
                    http2MinPingIntervalWithoutDataMs?: number;
                    http2MinTimeBetweenPingsMs?: number;
                    keepalivePermitWithoutCalls?: number;
                    keepaliveTimeMs?: number;
                    keepaliveTimeoutMs?: number;
                };
                loader?: {
                    alternateCommentMode?: boolean;
                    arrays?: boolean;
                    bytes?: Function;
                    defaults?: boolean;
                    enums?: Function;
                    includeDirs?: string[];
                    json?: boolean;
                    keepCase?: boolean;
                    longs?: Function;
                    objects?: boolean;
                    oneofs?: boolean;
                };
                maxMetadataSize?: number;
                maxReceiveMessageLength?: number;
                maxSendMessageLength?: number;
                onLoadPackageDefinition?: (pkg: any, server: any) => void;
                package: string | string[];
                packageDefinition?: any;
                protoLoader?: string;
                protoPath?: string | string[];
                url?: string;
            }
            | {
                deserializer?: Deserializer<any, any>;
                host?: string;
                port?: number;
                retryAttempts?: number;
                retryDelay?: number;
                serializer?: Serializer<any, any>;
                wildcards?: boolean;
            } & IORedisOptions
            | {
                authenticator?: any;
                debug?: boolean;
                deserializer?: Deserializer<any, any>;
                encoding?: string;
                gracefulShutdown?: boolean;
                gracePeriod?: number;
                headers?: Record<string, string>;
                ignoreClusterUpdates?: boolean;
                inboxPrefix?: string;
                maxPingOut?: number;
                maxReconnectAttempts?: number;
                name?: string;
                nkey?: any;
                noEcho?: boolean;
                nonceSigner?: any;
                noRandomize?: boolean;
                pass?: string;
                pedantic?: boolean;
                pingInterval?: number;
                preserveBuffers?: boolean;
                queue?: string;
                reconnect?: boolean;
                reconnectDelayHandler?: any;
                reconnectJitter?: number;
                reconnectJitterTLS?: number;
                reconnectTimeWait?: number;
                serializer?: Serializer<any, any>;
                servers?: string | string[];
                timeout?: number;
                tls?: any;
                token?: string;
                tokenHandler?: any;
                useOldRequestStyle?: boolean;
                user?: string;
                userCreds?: any;
                userJWT?: string;
                verbose?: boolean;
                waitOnFirstConnect?: boolean;
                yieldTime?: number;
                [key: string]: any;
            }
            | MqttClientOptions & {
                deserializer?: Deserializer<any, any>;
                serializer?: Serializer<any, any>;
                subscribeOptions?: { nl?: boolean; qos: QoS; rap?: boolean; rh?: number };
                url?: string;
                userProperties?: Record<string, string | string[]>;
            }
            | {
                consumerTag?: string;
                deserializer?: Deserializer<any, any>;
                exchange?: string;
                headers?: Record<string, string>;
                isGlobalPrefetchCount?: boolean;
                maxConnectionAttempts?: number;
                noAck?: boolean;
                noAssert?: boolean;
                persistent?: boolean;
                prefetchCount?: number;
                queue?: string;
                queueOptions?: AmqplibQueueOptions;
                replyQueue?: string;
                routingKey?: string;
                serializer?: Serializer<any, any>;
                socketOptions?: AmqpConnectionManagerSocketOptions;
                urls?: string[] | RmqUrl[];
            }
            | {
                client?: KafkaConfig;
                consumer?: ConsumerConfig;
                deserializer?: Deserializer<any, any>;
                parser?: KafkaParserConfig;
                postfixId?: string;
                producer?: ProducerConfig;
                producerOnlyMode?: boolean;
                run?: Omit<ConsumerRunConfig, "eachBatch" | "eachMessage">;
                send?: Omit<ProducerRecord, "messages" | "topic">;
                serializer?: Serializer<any, any>;
                subscribe?: Omit<ConsumerSubscribeTopics, "topics">;
            }
            | {
                deserializer?: Deserializer<any, any>;
                host?: string;
                port?: number;
                serializer?: Serializer<any, any>;
                socketClass?: Type<TcpSocket>;
                tlsOptions?: ConnectionOptions;
            }
        • undefined
        • {
              channelOptions?: ChannelOptions;
              credentials?: any;
              gracefulShutdown?: boolean;
              keepalive?: {
                  http2MaxPingStrikes?: number;
                  http2MaxPingsWithoutData?: number;
                  http2MinPingIntervalWithoutDataMs?: number;
                  http2MinTimeBetweenPingsMs?: number;
                  keepalivePermitWithoutCalls?: number;
                  keepaliveTimeMs?: number;
                  keepaliveTimeoutMs?: number;
              };
              loader?: {
                  alternateCommentMode?: boolean;
                  arrays?: boolean;
                  bytes?: Function;
                  defaults?: boolean;
                  enums?: Function;
                  includeDirs?: string[];
                  json?: boolean;
                  keepCase?: boolean;
                  longs?: Function;
                  objects?: boolean;
                  oneofs?: boolean;
              };
              maxMetadataSize?: number;
              maxReceiveMessageLength?: number;
              maxSendMessageLength?: number;
              onLoadPackageDefinition?: (pkg: any, server: any) => void;
              package: string | string[];
              packageDefinition?: any;
              protoLoader?: string;
              protoPath?: string | string[];
              url?: string;
          }
        • {
              deserializer?: Deserializer<any, any>;
              host?: string;
              port?: number;
              retryAttempts?: number;
              retryDelay?: number;
              serializer?: Serializer<any, any>;
              wildcards?: boolean;
          } & IORedisOptions
          • Optionaldeserializer?: Deserializer<any, any>
          • Optionalhost?: string
          • Optionalport?: number
          • OptionalretryAttempts?: number
          • OptionalretryDelay?: number
          • Optionalserializer?: Serializer<any, any>
          • Optionalwildcards?: boolean

            Use psubscribe/pmessage to enable wildcards in the patterns

        • {
              authenticator?: any;
              debug?: boolean;
              deserializer?: Deserializer<any, any>;
              encoding?: string;
              gracefulShutdown?: boolean;
              gracePeriod?: number;
              headers?: Record<string, string>;
              ignoreClusterUpdates?: boolean;
              inboxPrefix?: string;
              maxPingOut?: number;
              maxReconnectAttempts?: number;
              name?: string;
              nkey?: any;
              noEcho?: boolean;
              nonceSigner?: any;
              noRandomize?: boolean;
              pass?: string;
              pedantic?: boolean;
              pingInterval?: number;
              preserveBuffers?: boolean;
              queue?: string;
              reconnect?: boolean;
              reconnectDelayHandler?: any;
              reconnectJitter?: number;
              reconnectJitterTLS?: number;
              reconnectTimeWait?: number;
              serializer?: Serializer<any, any>;
              servers?: string | string[];
              timeout?: number;
              tls?: any;
              token?: string;
              tokenHandler?: any;
              useOldRequestStyle?: boolean;
              user?: string;
              userCreds?: any;
              userJWT?: string;
              verbose?: boolean;
              waitOnFirstConnect?: boolean;
              yieldTime?: number;
              [key: string]: any;
          }
        • MqttClientOptions & {
              deserializer?: Deserializer<any, any>;
              serializer?: Serializer<any, any>;
              subscribeOptions?: { nl?: boolean; qos: QoS; rap?: boolean; rh?: number };
              url?: string;
              userProperties?: Record<string, string | string[]>;
          }
        • {
              consumerTag?: string;
              deserializer?: Deserializer<any, any>;
              exchange?: string;
              headers?: Record<string, string>;
              isGlobalPrefetchCount?: boolean;
              maxConnectionAttempts?: number;
              noAck?: boolean;
              noAssert?: boolean;
              persistent?: boolean;
              prefetchCount?: number;
              queue?: string;
              queueOptions?: AmqplibQueueOptions;
              replyQueue?: string;
              routingKey?: string;
              serializer?: Serializer<any, any>;
              socketOptions?: AmqpConnectionManagerSocketOptions;
              urls?: string[] | RmqUrl[];
          }
          • OptionalconsumerTag?: string
          • Optionaldeserializer?: Deserializer<any, any>
          • Optionalexchange?: string
          • Optionalheaders?: Record<string, string>
          • OptionalisGlobalPrefetchCount?: boolean
          • OptionalmaxConnectionAttempts?: number

            Maximum number of connection attempts. Applies only to the consumer configuration. -1 === infinite

            -1
            
          • OptionalnoAck?: boolean
          • OptionalnoAssert?: boolean
          • Optionalpersistent?: boolean
          • OptionalprefetchCount?: number
          • Optionalqueue?: string
          • OptionalqueueOptions?: AmqplibQueueOptions
          • OptionalreplyQueue?: string
          • OptionalroutingKey?: string
          • Optionalserializer?: Serializer<any, any>
          • OptionalsocketOptions?: AmqpConnectionManagerSocketOptions
          • Optionalurls?: string[] | RmqUrl[]
        • {
              client?: KafkaConfig;
              consumer?: ConsumerConfig;
              deserializer?: Deserializer<any, any>;
              parser?: KafkaParserConfig;
              postfixId?: string;
              producer?: ProducerConfig;
              producerOnlyMode?: boolean;
              run?: Omit<ConsumerRunConfig, "eachBatch" | "eachMessage">;
              send?: Omit<ProducerRecord, "messages" | "topic">;
              serializer?: Serializer<any, any>;
              subscribe?: Omit<ConsumerSubscribeTopics, "topics">;
          }
          • Optionalclient?: KafkaConfig
          • Optionalconsumer?: ConsumerConfig
          • Optionaldeserializer?: Deserializer<any, any>
          • Optionalparser?: KafkaParserConfig
          • OptionalpostfixId?: string

            Defaults to "-server" on server side and "-client" on client side.

          • Optionalproducer?: ProducerConfig
          • OptionalproducerOnlyMode?: boolean
          • Optionalrun?: Omit<ConsumerRunConfig, "eachBatch" | "eachMessage">
          • Optionalsend?: Omit<ProducerRecord, "messages" | "topic">
          • Optionalserializer?: Serializer<any, any>
          • Optionalsubscribe?: Omit<ConsumerSubscribeTopics, "topics">
        • {
              deserializer?: Deserializer<any, any>;
              host?: string;
              port?: number;
              serializer?: Serializer<any, any>;
              socketClass?: Type<TcpSocket>;
              tlsOptions?: ConnectionOptions;
          }

      Returns void

    • Parameters

      • options:
            | undefined
            | {
                channelOptions?: ChannelOptions;
                credentials?: any;
                gracefulShutdown?: boolean;
                keepalive?: {
                    http2MaxPingStrikes?: number;
                    http2MaxPingsWithoutData?: number;
                    http2MinPingIntervalWithoutDataMs?: number;
                    http2MinTimeBetweenPingsMs?: number;
                    keepalivePermitWithoutCalls?: number;
                    keepaliveTimeMs?: number;
                    keepaliveTimeoutMs?: number;
                };
                loader?: {
                    alternateCommentMode?: boolean;
                    arrays?: boolean;
                    bytes?: Function;
                    defaults?: boolean;
                    enums?: Function;
                    includeDirs?: string[];
                    json?: boolean;
                    keepCase?: boolean;
                    longs?: Function;
                    objects?: boolean;
                    oneofs?: boolean;
                };
                maxMetadataSize?: number;
                maxReceiveMessageLength?: number;
                maxSendMessageLength?: number;
                onLoadPackageDefinition?: (pkg: any, server: any) => void;
                package: string | string[];
                packageDefinition?: any;
                protoLoader?: string;
                protoPath?: string | string[];
                url?: string;
            }
            | {
                deserializer?: Deserializer<any, any>;
                host?: string;
                port?: number;
                retryAttempts?: number;
                retryDelay?: number;
                serializer?: Serializer<any, any>;
                wildcards?: boolean;
            } & IORedisOptions
            | {
                authenticator?: any;
                debug?: boolean;
                deserializer?: Deserializer<any, any>;
                encoding?: string;
                gracefulShutdown?: boolean;
                gracePeriod?: number;
                headers?: Record<string, string>;
                ignoreClusterUpdates?: boolean;
                inboxPrefix?: string;
                maxPingOut?: number;
                maxReconnectAttempts?: number;
                name?: string;
                nkey?: any;
                noEcho?: boolean;
                nonceSigner?: any;
                noRandomize?: boolean;
                pass?: string;
                pedantic?: boolean;
                pingInterval?: number;
                preserveBuffers?: boolean;
                queue?: string;
                reconnect?: boolean;
                reconnectDelayHandler?: any;
                reconnectJitter?: number;
                reconnectJitterTLS?: number;
                reconnectTimeWait?: number;
                serializer?: Serializer<any, any>;
                servers?: string | string[];
                timeout?: number;
                tls?: any;
                token?: string;
                tokenHandler?: any;
                useOldRequestStyle?: boolean;
                user?: string;
                userCreds?: any;
                userJWT?: string;
                verbose?: boolean;
                waitOnFirstConnect?: boolean;
                yieldTime?: number;
                [key: string]: any;
            }
            | MqttClientOptions & {
                deserializer?: Deserializer<any, any>;
                serializer?: Serializer<any, any>;
                subscribeOptions?: { nl?: boolean; qos: QoS; rap?: boolean; rh?: number };
                url?: string;
                userProperties?: Record<string, string | string[]>;
            }
            | {
                consumerTag?: string;
                deserializer?: Deserializer<any, any>;
                exchange?: string;
                headers?: Record<string, string>;
                isGlobalPrefetchCount?: boolean;
                maxConnectionAttempts?: number;
                noAck?: boolean;
                noAssert?: boolean;
                persistent?: boolean;
                prefetchCount?: number;
                queue?: string;
                queueOptions?: AmqplibQueueOptions;
                replyQueue?: string;
                routingKey?: string;
                serializer?: Serializer<any, any>;
                socketOptions?: AmqpConnectionManagerSocketOptions;
                urls?: string[] | RmqUrl[];
            }
            | {
                client?: KafkaConfig;
                consumer?: ConsumerConfig;
                deserializer?: Deserializer<any, any>;
                parser?: KafkaParserConfig;
                postfixId?: string;
                producer?: ProducerConfig;
                producerOnlyMode?: boolean;
                run?: Omit<ConsumerRunConfig, "eachBatch" | "eachMessage">;
                send?: Omit<ProducerRecord, "messages" | "topic">;
                serializer?: Serializer<any, any>;
                subscribe?: Omit<ConsumerSubscribeTopics, "topics">;
            }
            | {
                deserializer?: Deserializer<any, any>;
                host?: string;
                port?: number;
                serializer?: Serializer<any, any>;
                socketClass?: Type<TcpSocket>;
                tlsOptions?: ConnectionOptions;
            }
        • undefined
        • {
              channelOptions?: ChannelOptions;
              credentials?: any;
              gracefulShutdown?: boolean;
              keepalive?: {
                  http2MaxPingStrikes?: number;
                  http2MaxPingsWithoutData?: number;
                  http2MinPingIntervalWithoutDataMs?: number;
                  http2MinTimeBetweenPingsMs?: number;
                  keepalivePermitWithoutCalls?: number;
                  keepaliveTimeMs?: number;
                  keepaliveTimeoutMs?: number;
              };
              loader?: {
                  alternateCommentMode?: boolean;
                  arrays?: boolean;
                  bytes?: Function;
                  defaults?: boolean;
                  enums?: Function;
                  includeDirs?: string[];
                  json?: boolean;
                  keepCase?: boolean;
                  longs?: Function;
                  objects?: boolean;
                  oneofs?: boolean;
              };
              maxMetadataSize?: number;
              maxReceiveMessageLength?: number;
              maxSendMessageLength?: number;
              onLoadPackageDefinition?: (pkg: any, server: any) => void;
              package: string | string[];
              packageDefinition?: any;
              protoLoader?: string;
              protoPath?: string | string[];
              url?: string;
          }
        • {
              deserializer?: Deserializer<any, any>;
              host?: string;
              port?: number;
              retryAttempts?: number;
              retryDelay?: number;
              serializer?: Serializer<any, any>;
              wildcards?: boolean;
          } & IORedisOptions
          • Optionaldeserializer?: Deserializer<any, any>
          • Optionalhost?: string
          • Optionalport?: number
          • OptionalretryAttempts?: number
          • OptionalretryDelay?: number
          • Optionalserializer?: Serializer<any, any>
          • Optionalwildcards?: boolean

            Use psubscribe/pmessage to enable wildcards in the patterns

        • {
              authenticator?: any;
              debug?: boolean;
              deserializer?: Deserializer<any, any>;
              encoding?: string;
              gracefulShutdown?: boolean;
              gracePeriod?: number;
              headers?: Record<string, string>;
              ignoreClusterUpdates?: boolean;
              inboxPrefix?: string;
              maxPingOut?: number;
              maxReconnectAttempts?: number;
              name?: string;
              nkey?: any;
              noEcho?: boolean;
              nonceSigner?: any;
              noRandomize?: boolean;
              pass?: string;
              pedantic?: boolean;
              pingInterval?: number;
              preserveBuffers?: boolean;
              queue?: string;
              reconnect?: boolean;
              reconnectDelayHandler?: any;
              reconnectJitter?: number;
              reconnectJitterTLS?: number;
              reconnectTimeWait?: number;
              serializer?: Serializer<any, any>;
              servers?: string | string[];
              timeout?: number;
              tls?: any;
              token?: string;
              tokenHandler?: any;
              useOldRequestStyle?: boolean;
              user?: string;
              userCreds?: any;
              userJWT?: string;
              verbose?: boolean;
              waitOnFirstConnect?: boolean;
              yieldTime?: number;
              [key: string]: any;
          }
        • MqttClientOptions & {
              deserializer?: Deserializer<any, any>;
              serializer?: Serializer<any, any>;
              subscribeOptions?: { nl?: boolean; qos: QoS; rap?: boolean; rh?: number };
              url?: string;
              userProperties?: Record<string, string | string[]>;
          }
        • {
              consumerTag?: string;
              deserializer?: Deserializer<any, any>;
              exchange?: string;
              headers?: Record<string, string>;
              isGlobalPrefetchCount?: boolean;
              maxConnectionAttempts?: number;
              noAck?: boolean;
              noAssert?: boolean;
              persistent?: boolean;
              prefetchCount?: number;
              queue?: string;
              queueOptions?: AmqplibQueueOptions;
              replyQueue?: string;
              routingKey?: string;
              serializer?: Serializer<any, any>;
              socketOptions?: AmqpConnectionManagerSocketOptions;
              urls?: string[] | RmqUrl[];
          }
          • OptionalconsumerTag?: string
          • Optionaldeserializer?: Deserializer<any, any>
          • Optionalexchange?: string
          • Optionalheaders?: Record<string, string>
          • OptionalisGlobalPrefetchCount?: boolean
          • OptionalmaxConnectionAttempts?: number

            Maximum number of connection attempts. Applies only to the consumer configuration. -1 === infinite

            -1
            
          • OptionalnoAck?: boolean
          • OptionalnoAssert?: boolean
          • Optionalpersistent?: boolean
          • OptionalprefetchCount?: number
          • Optionalqueue?: string
          • OptionalqueueOptions?: AmqplibQueueOptions
          • OptionalreplyQueue?: string
          • OptionalroutingKey?: string
          • Optionalserializer?: Serializer<any, any>
          • OptionalsocketOptions?: AmqpConnectionManagerSocketOptions
          • Optionalurls?: string[] | RmqUrl[]
        • {
              client?: KafkaConfig;
              consumer?: ConsumerConfig;
              deserializer?: Deserializer<any, any>;
              parser?: KafkaParserConfig;
              postfixId?: string;
              producer?: ProducerConfig;
              producerOnlyMode?: boolean;
              run?: Omit<ConsumerRunConfig, "eachBatch" | "eachMessage">;
              send?: Omit<ProducerRecord, "messages" | "topic">;
              serializer?: Serializer<any, any>;
              subscribe?: Omit<ConsumerSubscribeTopics, "topics">;
          }
          • Optionalclient?: KafkaConfig
          • Optionalconsumer?: ConsumerConfig
          • Optionaldeserializer?: Deserializer<any, any>
          • Optionalparser?: KafkaParserConfig
          • OptionalpostfixId?: string

            Defaults to "-server" on server side and "-client" on client side.

          • Optionalproducer?: ProducerConfig
          • OptionalproducerOnlyMode?: boolean
          • Optionalrun?: Omit<ConsumerRunConfig, "eachBatch" | "eachMessage">
          • Optionalsend?: Omit<ProducerRecord, "messages" | "topic">
          • Optionalserializer?: Serializer<any, any>
          • Optionalsubscribe?: Omit<ConsumerSubscribeTopics, "topics">
        • {
              deserializer?: Deserializer<any, any>;
              host?: string;
              port?: number;
              serializer?: Serializer<any, any>;
              socketClass?: Type<TcpSocket>;
              tlsOptions?: ConnectionOptions;
          }

      Returns void

    • Method called when server is being initialized.

      Parameters

      • callback: () => void

        Function to be called upon initialization

      Returns Promise<void>

    • Type Parameters

      • T = any

      Parameters

      • name: string
      • ctx: string
      • Optionalloader: Function

      Returns T

    • Parameters

      • pattern: MsPattern

      Returns string

    • Protected

      Register the handler for the event

      Parameters

      • handler: MessageHandler

      Returns void

    • Parameters

      • stream$: Observable<any>
      • respond: (data: WritePacket) => void | Promise<unknown>

      Returns Subscription

    • Type Parameters

      • T

      Parameters

      • resultOrDeferred: Observable<T> | Promise<T>

      Returns Observable<T>

    • Type Parameters

      • T

      Parameters

      • resultOrDeferred: T

      Returns Observable<T>

    • Returns an instance of the underlying server/broker instance, or a group of servers if there are more than one.

      Type Parameters

      • T

      Returns T