Class SlackAssistant

Hierarchy (View Summary)

Slack
- SlackAssistant

Constructors

constructor

new SlackAssistant(options: SlackAssistantOptions): SlackAssistant
Parameters
- options: SlackAssistantOptions
Returns SlackAssistant
Overrides Slack.constructor
- Defined in packages/nestjs-slack-assistant/slack-assistant.ts:21

Properties

`Protected`_status$

_status$: ReplaySubject<string>

`Protected`deserializer

deserializer: ConsumerDeserializer

`Protected` `Readonly`logger

logger: LoggerService

`Protected` `Readonly`messageHandlers

messageHandlers: Map<string, MessageHandler<any, any, any>>

`Readonly`options

options: SlackAssistantOptions

`Protected`serializer

serializer: ConsumerSerializer

`Optional` `Readonly`transportId

transportId?: symbol | Transport

Unique transport identifier.

Accessors

status

get status(): Observable<Status>
Returns an observable that emits status changes.

Returns Observable<Status>
Inherited from Slack.status
- Defined in node_modules/@nestjs/microservices/server/server.d.ts:24

Methods

addHandler

addHandler(
    pattern: any,
    callback: MessageHandler,
    isEventHandler?: boolean,
    extras?: Record<string, any>,
): void
Parameters
- pattern: any
- callback: MessageHandler
- OptionalisEventHandler: boolean
- Optionalextras: Record<string, any>
Returns void
Inherited from Slack.addHandler
- Defined in node_modules/@nestjs/microservices/server/server.d.ts:45

`Protected`app

app(): App
Protected
Get/Create Bolt app instance

Returns App
Inherited from Slack.app
- Defined in packages/nestjs-slack/slack.ts:98

close

close(): Promise<void>
Method called when server is being terminated.

Returns Promise<void>
Inherited from Slack.close
- Defined in packages/nestjs-slack/slack.ts:50

getHandlerByPattern

getHandlerByPattern(pattern: string): null | MessageHandler<any, any, any>
Parameters
- pattern: string
Returns null | MessageHandler<any, any, any>
Inherited from Slack.getHandlerByPattern
- Defined in node_modules/@nestjs/microservices/server/server.d.ts:47

getHandlers

getHandlers(): Map<string, MessageHandler<any, any, any>>
Returns Map<string, MessageHandler<any, any, any>>
Inherited from Slack.getHandlers
- Defined in node_modules/@nestjs/microservices/server/server.d.ts:46

getOptionsProp

getOptionsProp<
    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,
>(
    obj: Options,
    prop: Attribute,
): 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
Parameters
- obj: Options
- prop: Attribute
Returns Options[Attribute]
Inherited from Slack.getOptionsProp
- Defined in node_modules/@nestjs/microservices/server/server.d.ts:52
getOptionsProp<
    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],
>(
    obj: Options,
    prop: Attribute,
    defaultValue: DefaultValue,
): Required<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
- obj: Options
- prop: Attribute
- defaultValue: DefaultValue
Returns Required<Options>[Attribute]
Inherited from Slack.getOptionsProp
- Defined in node_modules/@nestjs/microservices/server/server.d.ts:53

`Protected`getRouteFromPattern

getRouteFromPattern(pattern: string): string
Transforms the server Pattern to valid type and returns a route for him.
Parameters
- pattern: string
  server pattern
Returns string
string
Inherited from Slack.getRouteFromPattern
- Defined in node_modules/@nestjs/microservices/server/server.d.ts:64

`Protected`handleError

handleError(error: string): void
Parameters
- error: string
Returns void
Inherited from Slack.handleError
- Defined in node_modules/@nestjs/microservices/server/server.d.ts:54

handleEvent

handleEvent(
    pattern: string,
    packet: ReadPacket,
    context: BaseRpcContext,
): Promise<any>
Parameters
- pattern: string
- packet: ReadPacket
- context: BaseRpcContext
Returns Promise<any>
Inherited from Slack.handleEvent
- Defined in node_modules/@nestjs/microservices/server/server.d.ts:49

`Protected`initializeDeserializer

initializeDeserializer(
    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;
        },
): 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
    
    Default
    -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
Inherited from Slack.initializeDeserializer
- Defined in node_modules/@nestjs/microservices/server/server.d.ts:57

`Protected`initializeSerializer

initializeSerializer(
    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;
        },
): 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
    
    Default
    -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
Inherited from Slack.initializeSerializer
- Defined in node_modules/@nestjs/microservices/server/server.d.ts:56

listen

listen(callback: () => void): Promise<void>
Method called when server is being initialized.
Parameters
- callback: () => void
  Function to be called upon initialization
Returns Promise<void>
Overrides Slack.listen
- Defined in packages/nestjs-slack-assistant/slack-assistant.ts:25

`Protected`loadPackage

loadPackage<T = any>(name: string, ctx: string, loader?: Function): T
Type Parameters
- T = any
Parameters
- name: string
- ctx: string
- Optionalloader: Function
Returns T
Inherited from Slack.loadPackage
- Defined in node_modules/@nestjs/microservices/server/server.d.ts:55

`Protected`normalizePattern

normalizePattern(pattern: MsPattern): string
Parameters
- pattern: MsPattern
Returns string
Inherited from Slack.normalizePattern
- Defined in node_modules/@nestjs/microservices/server/server.d.ts:65

on

on(): void
Registers an event listener for the given event.

Returns void
Inherited from Slack.on
- Defined in packages/nestjs-slack/slack.ts:54

`Protected`register

register(handler: MessageHandler): void
Protected
Register the handler for the event
Parameters
- handler: MessageHandler
Returns void
Inherited from Slack.register
- Defined in packages/nestjs-slack/slack.ts:67

send

send(
stream$: Observable<any>,
respond: (data: WritePacket) => void | Promise<unknown>,
): Subscription
Parameters
- stream$: Observable<any>
- respond: (data: WritePacket) => void | Promise<unknown>
Returns Subscription
Inherited from Slack.send
- Defined in node_modules/@nestjs/microservices/server/server.d.ts:48

transformToObservable

transformToObservable<T>(
resultOrDeferred: Observable<T> | Promise<T>,
): Observable<T>
Type Parameters
- T
Parameters
- resultOrDeferred: Observable<T> | Promise<T>
Returns Observable<T>
Inherited from Slack.transformToObservable
- Defined in node_modules/@nestjs/microservices/server/server.d.ts:50
transformToObservable<T>(resultOrDeferred: T): Observable<T>
Type Parameters
- T
Parameters
- resultOrDeferred: T
Returns Observable<T>
Inherited from Slack.transformToObservable
- Defined in node_modules/@nestjs/microservices/server/server.d.ts:51

unwrap

unwrap<T>(): 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
Inherited from Slack.unwrap
- Defined in packages/nestjs-slack/slack.ts:58

Class SlackAssistant

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SlackAssistant

Properties

Protected_status$

Protecteddeserializer

Protected Readonlylogger

Protected ReadonlymessageHandlers

Readonlyoptions

Protectedserializer

Optional ReadonlytransportId

Accessors

status

Returns Observable<Status>

Methods

addHandler

Parameters

Returns void

Protectedapp

Returns App

close

Returns Promise<void>

getHandlerByPattern

Parameters

Returns null | MessageHandler<any, any, any>

getHandlers

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

getOptionsProp

Type Parameters

Parameters

Returns Options[Attribute]

Type Parameters

Parameters

Returns Required<Options>[Attribute]

ProtectedgetRouteFromPattern

Parameters

Returns string

ProtectedhandleError

Parameters

Returns void

handleEvent

Parameters

Returns Promise<any>

ProtectedinitializeDeserializer

Parameters

Optionaldeserializer?: Deserializer<any, any>

Optionalhost?: string

Optionalport?: number

OptionalretryAttempts?: number

OptionalretryDelay?: number

Optionalserializer?: Serializer<any, any>

Optionalwildcards?: boolean

OptionalconsumerTag?: string

Optionaldeserializer?: Deserializer<any, any>

Optionalexchange?: string

Optionalheaders?: Record<string, string>

OptionalisGlobalPrefetchCount?: boolean

OptionalmaxConnectionAttempts?: number

Default

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[]

Optionalclient?: KafkaConfig

Optionalconsumer?: ConsumerConfig

`Protected`_status$

`Protected`deserializer

`Protected` `Readonly`logger

`Protected` `Readonly`messageHandlers

`Readonly`options

`Protected`serializer

`Optional` `Readonly`transportId

`Protected`app

`Protected`getRouteFromPattern

`Protected`handleError

`Protected`initializeDeserializer

`Optional`deserializer?: Deserializer<any, any>

`Optional`host?: string

`Optional`port?: number

`Optional`retryAttempts?: number

`Optional`retryDelay?: number

`Optional`serializer?: Serializer<any, any>

`Optional`wildcards?: boolean

`Optional`consumerTag?: string

`Optional`deserializer?: Deserializer<any, any>

`Optional`exchange?: string

`Optional`headers?: Record<string, string>

`Optional`isGlobalPrefetchCount?: boolean

`Optional`maxConnectionAttempts?: number

`Optional`noAck?: boolean

`Optional`noAssert?: boolean

`Optional`persistent?: boolean

`Optional`prefetchCount?: number

`Optional`queue?: string

`Optional`queueOptions?: AmqplibQueueOptions

`Optional`replyQueue?: string

`Optional`routingKey?: string

`Optional`serializer?: Serializer<any, any>

`Optional`socketOptions?: AmqpConnectionManagerSocketOptions

`Optional`urls?: string[] | RmqUrl[]

`Optional`client?: KafkaConfig

`Optional`consumer?: ConsumerConfig

`Optional`deserializer?: Deserializer<any, any>

`Optional`parser?: KafkaParserConfig

`Optional`postfixId?: string

`Optional`producer?: ProducerConfig

`Optional`producerOnlyMode?: boolean

`Optional`run?: Omit<ConsumerRunConfig, "eachBatch" | "eachMessage">

`Optional`send?: Omit<ProducerRecord, "messages" | "topic">

`Optional`serializer?: Serializer<any, any>

`Optional`subscribe?: Omit<ConsumerSubscribeTopics, "topics">

`Protected`initializeSerializer

`Optional`deserializer?: Deserializer<any, any>

`Optional`host?: string

`Optional`port?: number

`Optional`retryAttempts?: number

`Optional`retryDelay?: number

`Optional`serializer?: Serializer<any, any>

`Optional`wildcards?: boolean

`Optional`consumerTag?: string

`Optional`deserializer?: Deserializer<any, any>

`Optional`exchange?: string

`Optional`headers?: Record<string, string>

`Optional`isGlobalPrefetchCount?: boolean

`Optional`maxConnectionAttempts?: number

`Optional`noAck?: boolean

`Optional`noAssert?: boolean

`Optional`persistent?: boolean

`Optional`prefetchCount?: number

`Optional`queue?: string

`Optional`queueOptions?: AmqplibQueueOptions

`Optional`replyQueue?: string

`Optional`routingKey?: string

`Optional`serializer?: Serializer<any, any>

`Optional`socketOptions?: AmqpConnectionManagerSocketOptions

`Optional`urls?: string[] | RmqUrl[]

`Optional`client?: KafkaConfig

`Optional`consumer?: ConsumerConfig

`Optional`deserializer?: Deserializer<any, any>

`Optional`parser?: KafkaParserConfig

`Optional`postfixId?: string

`Optional`producer?: ProducerConfig

`Optional`producerOnlyMode?: boolean

`Optional`run?: Omit<ConsumerRunConfig, "eachBatch" | "eachMessage">

`Optional`send?: Omit<ProducerRecord, "messages" | "topic">