Skip to main content

@nestjs-mod/microservices

NestJS microservice modules for NestJS-mod

NPM version monthly downloads Telegram Discord

Installation

npm i --save @nestjs/microservices @nestjs-mod/microservices

Modules

LinkCategoryDescription
GrpcNestMicroservicesystemGRPC NestJS-mod microservice initializer @see https://docs.nestjs.com/microservices/grpc
GrpcNestMicroserviceClientModulesystemGRPC NestJS-mod microservice client @see https://docs.nestjs.com/microservices/grpc
KafkaNestMicroservicesystemKafka NestJS-mod microservice initializer @see https://docs.nestjs.com/microservices/kafka
KafkaNestMicroserviceClientModulesystemKafka NestJS-mod microservice client @see https://docs.nestjs.com/microservices/kafka
MqttNestMicroservicesystemMQTT NestJS-mod microservice initializer @see https://docs.nestjs.com/microservices/mqtt
MqttNestMicroserviceClientModulesystemMQTT NestJS-mod microservice client @see https://docs.nestjs.com/microservices/mqtt
NatsNestMicroservicesystemNats NestJS-mod microservice initializer @see https://docs.nestjs.com/microservices/nats
NatsNestMicroserviceClientModulesystemNats NestJS-mod microservice client @see https://docs.nestjs.com/microservices/nats
RedisNestMicroservicesystemRedis NestJS-mod microservice initializer @see https://docs.nestjs.com/microservices/redis
RedisNestMicroserviceClientModulesystemRedis NestJS-mod microservice client @see https://docs.nestjs.com/microservices/redis
RmqNestMicroservicesystemRabbitMQ NestJS-mod microservice initializer @see https://docs.nestjs.com/microservices/rabbitmq
RmqNestMicroserviceClientModulesystemRabbitMQ NestJS-mod microservice client @see https://docs.nestjs.com/microservices/rabbitmq
TcpNestMicroservicesystemTCP NestJS-mod microservice initializer @see https://docs.nestjs.com/microservices/basics
TcpNestMicroserviceClientModulesystemTCP NestJS-mod microservice client @see https://docs.nestjs.com/microservices/basics

Modules descriptions

GrpcNestMicroservice

GRPC NestJS-mod microservice initializer @see https://docs.nestjs.com/microservices/grpc

Static environments

KeyDescriptionSourcesConstraintsDefaultValue
urlUrlobj['url'], process.env['GRPC_URL']optional--

Static configuration

KeyDescriptionConstraintsDefaultValue
defaultLoggerDefault logger for applicationoptional--
loggerSpecifies the logger to use. Pass false to turn off logging.optional--
abortOnErrorWhether to abort the process on Error. By default, the process is exited. Pass false to override the default behavior. If false is passed, Nest will not exit the application and instead will rethrow the exception. @default trueoptional--
bufferLogsIf enabled, logs will be buffered until the "Logger#flush" method is called. @default falseoptional--
autoFlushLogsIf enabled, logs will be automatically flushed and buffer detached when application initialization process either completes or fails. @default trueoptional--
previewWhether to run application in the preview mode. In the preview mode, providers/controllers are not instantiated & resolved. @default falseoptional--
snapshotWhether to generate a serialized graph snapshot. @default falseoptional--
featureNameFeature name for generate prefix to environments keysoptional--
microserviceProjectNameMicroservice project name for generate prefix to environments keys (need only for microservice client)optional--
maxSendMessageLengthMax send message lengthoptional--
maxReceiveMessageLengthMax receive message lengthoptional--
maxMetadataSizeMax metadata sizeoptional--
keepaliveKeepaliveoptional--
channelOptionsChannel optionsoptional--
credentialsCredentialsoptional--
protoPathProto pathoptional--
packagePackageisNotEmpty (package should not be empty)--
protoLoaderProto Loaderoptional--
packageDefinitionPackage definitionoptional--
gracefulShutdownGracefulShutdownoptional--
loaderLoaderoptional--

Back to Top


GrpcNestMicroserviceClientModule

GRPC NestJS-mod microservice client @see https://docs.nestjs.com/microservices/grpc

Shared providers

GrpcNestMicroserviceClient, ClientProxyApplicationHooks

Static environments

KeyDescriptionSourcesConstraintsDefaultValue
urlUrlobj['url'], process.env['GRPC_URL']optional--

Static configuration

KeyDescriptionConstraintsDefaultValue
defaultLoggerDefault logger for applicationoptional--
loggerSpecifies the logger to use. Pass false to turn off logging.optional--
abortOnErrorWhether to abort the process on Error. By default, the process is exited. Pass false to override the default behavior. If false is passed, Nest will not exit the application and instead will rethrow the exception. @default trueoptional--
bufferLogsIf enabled, logs will be buffered until the "Logger#flush" method is called. @default falseoptional--
autoFlushLogsIf enabled, logs will be automatically flushed and buffer detached when application initialization process either completes or fails. @default trueoptional--
previewWhether to run application in the preview mode. In the preview mode, providers/controllers are not instantiated & resolved. @default falseoptional--
snapshotWhether to generate a serialized graph snapshot. @default falseoptional--
featureNameFeature name for generate prefix to environments keysoptional--
microserviceProjectNameMicroservice project name for generate prefix to environments keys (need only for microservice client)optional--
maxSendMessageLengthMax send message lengthoptional--
maxReceiveMessageLengthMax receive message lengthoptional--
maxMetadataSizeMax metadata sizeoptional--
keepaliveKeepaliveoptional--
channelOptionsChannel optionsoptional--
credentialsCredentialsoptional--
protoPathProto pathoptional--
packagePackageisNotEmpty (package should not be empty)--
protoLoaderProto Loaderoptional--
packageDefinitionPackage definitionoptional--
gracefulShutdownGracefulShutdownoptional--
loaderLoaderoptional--

Back to Top


KafkaNestMicroservice

Kafka NestJS-mod microservice initializer @see https://docs.nestjs.com/microservices/kafka

Static environments

KeyDescriptionSourcesConstraintsDefaultValue
brokersBrokersobj['brokers'], process.env['KAFKA_BROKERS']optional--

Static configuration

KeyDescriptionConstraintsDefaultValue
defaultLoggerDefault logger for applicationoptional--
loggerSpecifies the logger to use. Pass false to turn off logging.optional--
abortOnErrorWhether to abort the process on Error. By default, the process is exited. Pass false to override the default behavior. If false is passed, Nest will not exit the application and instead will rethrow the exception. @default trueoptional--
bufferLogsIf enabled, logs will be buffered until the "Logger#flush" method is called. @default falseoptional--
autoFlushLogsIf enabled, logs will be automatically flushed and buffer detached when application initialization process either completes or fails. @default trueoptional--
previewWhether to run application in the preview mode. In the preview mode, providers/controllers are not instantiated & resolved. @default falseoptional--
snapshotWhether to generate a serialized graph snapshot. @default falseoptional--
featureNameFeature name for generate prefix to environments keysoptional--
microserviceProjectNameMicroservice project name for generate prefix to environments keys (need only for microservice client)optional--
serializerSerializeroptional--
deserializerDeserializeroptional--
postfixIdDefaults to "-server" on server side and "-client" on client sideoptional--
clientClientoptional--
consumerConsumer configoptional--
runConsumer run configoptional--
subscribeSubscribeoptional--
producerProducer configoptional--
sendSend producer recordoptional--
parserKafka parser configoptional--
producerOnlyModeProducer only modeoptional--

Back to Top


KafkaNestMicroserviceClientModule

Kafka NestJS-mod microservice client @see https://docs.nestjs.com/microservices/kafka

Shared providers

KafkaNestMicroserviceClient, ClientProxyApplicationHooks

Static environments

KeyDescriptionSourcesConstraintsDefaultValue
brokersBrokersobj['brokers'], process.env['KAFKA_BROKERS']optional--

Static configuration

KeyDescriptionConstraintsDefaultValue
defaultLoggerDefault logger for applicationoptional--
loggerSpecifies the logger to use. Pass false to turn off logging.optional--
abortOnErrorWhether to abort the process on Error. By default, the process is exited. Pass false to override the default behavior. If false is passed, Nest will not exit the application and instead will rethrow the exception. @default trueoptional--
bufferLogsIf enabled, logs will be buffered until the "Logger#flush" method is called. @default falseoptional--
autoFlushLogsIf enabled, logs will be automatically flushed and buffer detached when application initialization process either completes or fails. @default trueoptional--
previewWhether to run application in the preview mode. In the preview mode, providers/controllers are not instantiated & resolved. @default falseoptional--
snapshotWhether to generate a serialized graph snapshot. @default falseoptional--
featureNameFeature name for generate prefix to environments keysoptional--
microserviceProjectNameMicroservice project name for generate prefix to environments keys (need only for microservice client)optional--
serializerSerializeroptional--
deserializerDeserializeroptional--
postfixIdDefaults to "-server" on server side and "-client" on client sideoptional--
clientClientoptional--
consumerConsumer configoptional--
runConsumer run configoptional--
subscribeSubscribeoptional--
producerProducer configoptional--
sendSend producer recordoptional--
parserKafka parser configoptional--
producerOnlyModeProducer only modeoptional--

Back to Top


MqttNestMicroservice

MQTT NestJS-mod microservice initializer @see https://docs.nestjs.com/microservices/mqtt

Static environments

KeyDescriptionSourcesConstraintsDefaultValue
urlUrlobj['url'], process.env['MQTT_URL']optional--

Static configuration

KeyDescriptionConstraintsDefaultValue
defaultLoggerDefault logger for applicationoptional--
loggerSpecifies the logger to use. Pass false to turn off logging.optional--
abortOnErrorWhether to abort the process on Error. By default, the process is exited. Pass false to override the default behavior. If false is passed, Nest will not exit the application and instead will rethrow the exception. @default trueoptional--
bufferLogsIf enabled, logs will be buffered until the "Logger#flush" method is called. @default falseoptional--
autoFlushLogsIf enabled, logs will be automatically flushed and buffer detached when application initialization process either completes or fails. @default trueoptional--
previewWhether to run application in the preview mode. In the preview mode, providers/controllers are not instantiated & resolved. @default falseoptional--
snapshotWhether to generate a serialized graph snapshot. @default falseoptional--
featureNameFeature name for generate prefix to environments keysoptional--
microserviceProjectNameMicroservice project name for generate prefix to environments keys (need only for microservice client)optional--
serializerSerializeroptional--
deserializerDeserializeroptional--
subscribeOptionsSubscribe optionsoptional--
userPropertiesUser propertiesoptional--

Back to Top


MqttNestMicroserviceClientModule

MQTT NestJS-mod microservice client @see https://docs.nestjs.com/microservices/mqtt

Shared providers

MqttNestMicroserviceClient, ClientProxyApplicationHooks

Static environments

KeyDescriptionSourcesConstraintsDefaultValue
urlUrlobj['url'], process.env['MQTT_URL']optional--

Static configuration

KeyDescriptionConstraintsDefaultValue
defaultLoggerDefault logger for applicationoptional--
loggerSpecifies the logger to use. Pass false to turn off logging.optional--
abortOnErrorWhether to abort the process on Error. By default, the process is exited. Pass false to override the default behavior. If false is passed, Nest will not exit the application and instead will rethrow the exception. @default trueoptional--
bufferLogsIf enabled, logs will be buffered until the "Logger#flush" method is called. @default falseoptional--
autoFlushLogsIf enabled, logs will be automatically flushed and buffer detached when application initialization process either completes or fails. @default trueoptional--
previewWhether to run application in the preview mode. In the preview mode, providers/controllers are not instantiated & resolved. @default falseoptional--
snapshotWhether to generate a serialized graph snapshot. @default falseoptional--
featureNameFeature name for generate prefix to environments keysoptional--
microserviceProjectNameMicroservice project name for generate prefix to environments keys (need only for microservice client)optional--
serializerSerializeroptional--
deserializerDeserializeroptional--
subscribeOptionsSubscribe optionsoptional--
userPropertiesUser propertiesoptional--

Back to Top


NatsNestMicroservice

Nats NestJS-mod microservice initializer @see https://docs.nestjs.com/microservices/nats

Static environments

KeyDescriptionSourcesConstraintsDefaultValue
nameNameobj['name'], process.env['NATS_NAME']optional--
userUserobj['user'], process.env['NATS_USER']optional--
passPassobj['pass'], process.env['NATS_PASS']optional--
serversServersobj['servers'], process.env['NATS_SERVERS']optional--

Static configuration

KeyDescriptionConstraintsDefaultValue
defaultLoggerDefault logger for applicationoptional--
loggerSpecifies the logger to use. Pass false to turn off logging.optional--
abortOnErrorWhether to abort the process on Error. By default, the process is exited. Pass false to override the default behavior. If false is passed, Nest will not exit the application and instead will rethrow the exception. @default trueoptional--
bufferLogsIf enabled, logs will be buffered until the "Logger#flush" method is called. @default falseoptional--
autoFlushLogsIf enabled, logs will be automatically flushed and buffer detached when application initialization process either completes or fails. @default trueoptional--
previewWhether to run application in the preview mode. In the preview mode, providers/controllers are not instantiated & resolved. @default falseoptional--
snapshotWhether to generate a serialized graph snapshot. @default falseoptional--
featureNameFeature name for generate prefix to environments keysoptional--
microserviceProjectNameMicroservice project name for generate prefix to environments keys (need only for microservice client)optional--
headersHeadersoptional--
authenticatorAuthenticatoroptional--
debugDebugoptional--
ignoreClusterUpdatesIgnore cluster updatesoptional--
inboxPrefixInbox prefixoptional--
encodingEncodingoptional--
maxPingOutMax ping outoptional--
maxReconnectAttemptsMax reconnect attemptsoptional--
reconnectTimeWaitReconnect time waitoptional--
reconnectJitterReconnect jitteroptional--
reconnectJitterTLSReconnect jitter TLSoptional--
reconnectDelayHandlerReconnect delay handleroptional--
nkeyNkeyoptional--
reconnectReconnectoptional--
pedanticPedanticoptional--
tlsTLSoptional--
queueQueueoptional--
serializerSerializeroptional--
deserializerDeserializeroptional--
userJWTUser JWToptional--
nonceSignerNonce signeroptional--
userCredsUser credsoptional--
useOldRequestStyleUse old request styleoptional--
pingIntervalPing intervaloptional--
preserveBuffersPreserve buffersoptional--
waitOnFirstConnectWait on first connectoptional--
verboseVerboseoptional--
noEchoNo echooptional--
noRandomizeNo randomizeoptional--
timeoutTimeoutoptional--
tokenTokenoptional--
yieldTimeYield timeoptional--
tokenHandlerToken handleroptional--

Back to Top


NatsNestMicroserviceClientModule

Nats NestJS-mod microservice client @see https://docs.nestjs.com/microservices/nats

Shared providers

NatsNestMicroserviceClient, ClientProxyApplicationHooks

Static environments

KeyDescriptionSourcesConstraintsDefaultValue
nameNameobj['name'], process.env['NATS_NAME']optional--
userUserobj['user'], process.env['NATS_USER']optional--
passPassobj['pass'], process.env['NATS_PASS']optional--
serversServersobj['servers'], process.env['NATS_SERVERS']optional--

Static configuration

KeyDescriptionConstraintsDefaultValue
defaultLoggerDefault logger for applicationoptional--
loggerSpecifies the logger to use. Pass false to turn off logging.optional--
abortOnErrorWhether to abort the process on Error. By default, the process is exited. Pass false to override the default behavior. If false is passed, Nest will not exit the application and instead will rethrow the exception. @default trueoptional--
bufferLogsIf enabled, logs will be buffered until the "Logger#flush" method is called. @default falseoptional--
autoFlushLogsIf enabled, logs will be automatically flushed and buffer detached when application initialization process either completes or fails. @default trueoptional--
previewWhether to run application in the preview mode. In the preview mode, providers/controllers are not instantiated & resolved. @default falseoptional--
snapshotWhether to generate a serialized graph snapshot. @default falseoptional--
featureNameFeature name for generate prefix to environments keysoptional--
microserviceProjectNameMicroservice project name for generate prefix to environments keys (need only for microservice client)optional--
headersHeadersoptional--
authenticatorAuthenticatoroptional--
debugDebugoptional--
ignoreClusterUpdatesIgnore cluster updatesoptional--
inboxPrefixInbox prefixoptional--
encodingEncodingoptional--
maxPingOutMax ping outoptional--
maxReconnectAttemptsMax reconnect attemptsoptional--
reconnectTimeWaitReconnect time waitoptional--
reconnectJitterReconnect jitteroptional--
reconnectJitterTLSReconnect jitter TLSoptional--
reconnectDelayHandlerReconnect delay handleroptional--
nkeyNkeyoptional--
reconnectReconnectoptional--
pedanticPedanticoptional--
tlsTLSoptional--
queueQueueoptional--
serializerSerializeroptional--
deserializerDeserializeroptional--
userJWTUser JWToptional--
nonceSignerNonce signeroptional--
userCredsUser credsoptional--
useOldRequestStyleUse old request styleoptional--
pingIntervalPing intervaloptional--
preserveBuffersPreserve buffersoptional--
waitOnFirstConnectWait on first connectoptional--
verboseVerboseoptional--
noEchoNo echooptional--
noRandomizeNo randomizeoptional--
timeoutTimeoutoptional--
tokenTokenoptional--
yieldTimeYield timeoptional--
tokenHandlerToken handleroptional--

Back to Top


RedisNestMicroservice

Redis NestJS-mod microservice initializer @see https://docs.nestjs.com/microservices/redis

Static environments

KeyDescriptionSourcesConstraintsDefaultValue
hostHostobj['host'], process.env['REDIS_HOST']optional--
portPortobj['port'], process.env['REDIS_PORT']optional63796379
usernameIf set, client will send AUTH command with the value of this option as the first argument when connected, this is supported since Redis 6obj['username'], process.env['REDIS_USERNAME']optional--
passwordIf set, client will send AUTH command with the value of this option when connectedobj['password'], process.env['REDIS_PASSWORD']optional--
dbDatabase index to useobj['db'], process.env['REDIS_DB']optional00

Static configuration

KeyDescriptionConstraintsDefaultValue
defaultLoggerDefault logger for applicationoptional--
loggerSpecifies the logger to use. Pass false to turn off logging.optional--
abortOnErrorWhether to abort the process on Error. By default, the process is exited. Pass false to override the default behavior. If false is passed, Nest will not exit the application and instead will rethrow the exception. @default trueoptional--
bufferLogsIf enabled, logs will be buffered until the "Logger#flush" method is called. @default falseoptional--
autoFlushLogsIf enabled, logs will be automatically flushed and buffer detached when application initialization process either completes or fails. @default trueoptional--
previewWhether to run application in the preview mode. In the preview mode, providers/controllers are not instantiated & resolved. @default falseoptional--
snapshotWhether to generate a serialized graph snapshot. @default falseoptional--
featureNameFeature name for generate prefix to environments keysoptional--
microserviceProjectNameMicroservice project name for generate prefix to environments keys (need only for microservice client)optional--
retryAttemptsRetry attemptsoptional--
retryDelayRetry delayoptional--
wildcardsWildcardsoptional--
serializerSerializeroptional--
deserializerDeserializeroptional--
ConnectorConnectoroptional--
retryStrategyRetry strategyoptional--
commandTimeoutCommand timeoutoptional--
keepAliveKeep aliveoptional--
noDelayNo delayoptional--
connectionNameConnection nameoptional--
autoResubscribeAuto resubscribeoptional--
autoResendUnfulfilledCommandsAuto resend unfulfilled commandsoptional--
reconnectOnErrorReconnect on erroroptional--
readOnlyRead onlyoptional--
stringNumbersString numbersoptional--
connectTimeoutConnect timeoutoptional--
monitorMonitoroptional--
maxRetriesPerRequestMax retries per requestoptional--
maxLoadingRetryTimeMax loading retry timeoptional--
enableAutoPipeliningEnable auto pipeliningoptional--
autoPipeliningIgnoredCommandsAuto pipelining ignored commandsoptional--
offlineQueueOffline queueoptional--
commandQueueCommand queueoptional--
enableOfflineQueueEnable offline queueoptional--
enableReadyCheckThe client will sent an INFO command to check whether the server is still loading data from the disk ( which happens when the server is just launched) when the connection is established, and only wait until the loading process is finished before emitting the ready event (default: true).optional--
lazyConnectWhen a Redis instance is initialized, a connection to the server is immediately established. Set this to true will delay the connection to the server until the first command is sent or redis.connect() is called explicitly (default: false).optional--
scriptsScriptsoptional--
keyPrefixKey prefixoptional--
showFriendlyErrorStackShow friendly error stackoptional--
disconnectTimeoutDisconnect timeoutoptional--
tlsConnection optionsoptional--
nameMaster group name of the Sentineloptional--
roleRoleoptional--
sentinelUsernameSentinel usernameoptional--
sentinelPasswordSentinel passwordoptional--
sentinelsSentinelsoptional--
sentinelRetryStrategySentinel retry strategyoptional--
sentinelReconnectStrategySentinel reconnect strategyoptional--
preferredSlavesPreferred slavesoptional--
sentinelCommandTimeoutSentinel command timeoutoptional--
enableTLSForSentinelModeEnable TLS for sentinel modeoptional--
sentinelTLSSentinel TLSoptional--
natMapNat mapoptional--
updateSentinelsUpdate sentinelsoptional--
sentinelMaxConnectionsSentinel max connectionsoptional--
failoverDetectorFailover detectoroptional--

Back to Top


RedisNestMicroserviceClientModule

Redis NestJS-mod microservice client @see https://docs.nestjs.com/microservices/redis

Shared providers

RedisNestMicroserviceClient, ClientProxyApplicationHooks

Static environments

KeyDescriptionSourcesConstraintsDefaultValue
hostHostobj['host'], process.env['REDIS_HOST']optional--
portPortobj['port'], process.env['REDIS_PORT']optional63796379
usernameIf set, client will send AUTH command with the value of this option as the first argument when connected, this is supported since Redis 6obj['username'], process.env['REDIS_USERNAME']optional--
passwordIf set, client will send AUTH command with the value of this option when connectedobj['password'], process.env['REDIS_PASSWORD']optional--
dbDatabase index to useobj['db'], process.env['REDIS_DB']optional00

Static configuration

KeyDescriptionConstraintsDefaultValue
defaultLoggerDefault logger for applicationoptional--
loggerSpecifies the logger to use. Pass false to turn off logging.optional--
abortOnErrorWhether to abort the process on Error. By default, the process is exited. Pass false to override the default behavior. If false is passed, Nest will not exit the application and instead will rethrow the exception. @default trueoptional--
bufferLogsIf enabled, logs will be buffered until the "Logger#flush" method is called. @default falseoptional--
autoFlushLogsIf enabled, logs will be automatically flushed and buffer detached when application initialization process either completes or fails. @default trueoptional--
previewWhether to run application in the preview mode. In the preview mode, providers/controllers are not instantiated & resolved. @default falseoptional--
snapshotWhether to generate a serialized graph snapshot. @default falseoptional--
featureNameFeature name for generate prefix to environments keysoptional--
microserviceProjectNameMicroservice project name for generate prefix to environments keys (need only for microservice client)optional--
retryAttemptsRetry attemptsoptional--
retryDelayRetry delayoptional--
wildcardsWildcardsoptional--
serializerSerializeroptional--
deserializerDeserializeroptional--
ConnectorConnectoroptional--
retryStrategyRetry strategyoptional--
commandTimeoutCommand timeoutoptional--
keepAliveKeep aliveoptional--
noDelayNo delayoptional--
connectionNameConnection nameoptional--
autoResubscribeAuto resubscribeoptional--
autoResendUnfulfilledCommandsAuto resend unfulfilled commandsoptional--
reconnectOnErrorReconnect on erroroptional--
readOnlyRead onlyoptional--
stringNumbersString numbersoptional--
connectTimeoutConnect timeoutoptional--
monitorMonitoroptional--
maxRetriesPerRequestMax retries per requestoptional--
maxLoadingRetryTimeMax loading retry timeoptional--
enableAutoPipeliningEnable auto pipeliningoptional--
autoPipeliningIgnoredCommandsAuto pipelining ignored commandsoptional--
offlineQueueOffline queueoptional--
commandQueueCommand queueoptional--
enableOfflineQueueEnable offline queueoptional--
enableReadyCheckThe client will sent an INFO command to check whether the server is still loading data from the disk ( which happens when the server is just launched) when the connection is established, and only wait until the loading process is finished before emitting the ready event (default: true).optional--
lazyConnectWhen a Redis instance is initialized, a connection to the server is immediately established. Set this to true will delay the connection to the server until the first command is sent or redis.connect() is called explicitly (default: false).optional--
scriptsScriptsoptional--
keyPrefixKey prefixoptional--
showFriendlyErrorStackShow friendly error stackoptional--
disconnectTimeoutDisconnect timeoutoptional--
tlsConnection optionsoptional--
nameMaster group name of the Sentineloptional--
roleRoleoptional--
sentinelUsernameSentinel usernameoptional--
sentinelPasswordSentinel passwordoptional--
sentinelsSentinelsoptional--
sentinelRetryStrategySentinel retry strategyoptional--
sentinelReconnectStrategySentinel reconnect strategyoptional--
preferredSlavesPreferred slavesoptional--
sentinelCommandTimeoutSentinel command timeoutoptional--
enableTLSForSentinelModeEnable TLS for sentinel modeoptional--
sentinelTLSSentinel TLSoptional--
natMapNat mapoptional--
updateSentinelsUpdate sentinelsoptional--
sentinelMaxConnectionsSentinel max connectionsoptional--
failoverDetectorFailover detectoroptional--

Back to Top


RmqNestMicroservice

RabbitMQ NestJS-mod microservice initializer @see https://docs.nestjs.com/microservices/rabbitmq

Static environments

KeyDescriptionSourcesConstraintsDefaultValue
urlsUrlsobj['urls'], process.env['RMQ_URLS']optional--

Static configuration

KeyDescriptionConstraintsDefaultValue
defaultLoggerDefault logger for applicationoptional--
loggerSpecifies the logger to use. Pass false to turn off logging.optional--
abortOnErrorWhether to abort the process on Error. By default, the process is exited. Pass false to override the default behavior. If false is passed, Nest will not exit the application and instead will rethrow the exception. @default trueoptional--
bufferLogsIf enabled, logs will be buffered until the "Logger#flush" method is called. @default falseoptional--
autoFlushLogsIf enabled, logs will be automatically flushed and buffer detached when application initialization process either completes or fails. @default trueoptional--
previewWhether to run application in the preview mode. In the preview mode, providers/controllers are not instantiated & resolved. @default falseoptional--
snapshotWhether to generate a serialized graph snapshot. @default falseoptional--
featureNameFeature name for generate prefix to environments keysoptional--
microserviceProjectNameMicroservice project name for generate prefix to environments keys (need only for microservice client)optional--
queueQueueoptional--
prefetchCountPrefetch countoptional--
isGlobalPrefetchCountIs global prefetch countoptional--
queueOptionsQueue optionsoptional--
socketOptionsSocket optionsoptional--
noAckNo ackoptional--
consumerTagConsumer tagoptional--
serializerSerializeroptional--
deserializerDeserializeroptional--
replyQueueReply queueoptional--
persistentPersistentoptional--
headersHeadersoptional--
noAssertNo assertoptional--
maxConnectionAttemptsMaximum number of connection attempts, applies only to the consumer configuration (-1 - infinite)optional--

Back to Top


RmqNestMicroserviceClientModule

RabbitMQ NestJS-mod microservice client @see https://docs.nestjs.com/microservices/rabbitmq

Shared providers

RmqNestMicroserviceClient, ClientProxyApplicationHooks

Static environments

KeyDescriptionSourcesConstraintsDefaultValue
urlsUrlsobj['urls'], process.env['RMQ_URLS']optional--

Static configuration

KeyDescriptionConstraintsDefaultValue
defaultLoggerDefault logger for applicationoptional--
loggerSpecifies the logger to use. Pass false to turn off logging.optional--
abortOnErrorWhether to abort the process on Error. By default, the process is exited. Pass false to override the default behavior. If false is passed, Nest will not exit the application and instead will rethrow the exception. @default trueoptional--
bufferLogsIf enabled, logs will be buffered until the "Logger#flush" method is called. @default falseoptional--
autoFlushLogsIf enabled, logs will be automatically flushed and buffer detached when application initialization process either completes or fails. @default trueoptional--
previewWhether to run application in the preview mode. In the preview mode, providers/controllers are not instantiated & resolved. @default falseoptional--
snapshotWhether to generate a serialized graph snapshot. @default falseoptional--
featureNameFeature name for generate prefix to environments keysoptional--
microserviceProjectNameMicroservice project name for generate prefix to environments keys (need only for microservice client)optional--
queueQueueoptional--
prefetchCountPrefetch countoptional--
isGlobalPrefetchCountIs global prefetch countoptional--
queueOptionsQueue optionsoptional--
socketOptionsSocket optionsoptional--
noAckNo ackoptional--
consumerTagConsumer tagoptional--
serializerSerializeroptional--
deserializerDeserializeroptional--
replyQueueReply queueoptional--
persistentPersistentoptional--
headersHeadersoptional--
noAssertNo assertoptional--
maxConnectionAttemptsMaximum number of connection attempts, applies only to the consumer configuration (-1 - infinite)optional--

Back to Top


TcpNestMicroservice

TCP NestJS-mod microservice initializer @see https://docs.nestjs.com/microservices/basics

Static environments

KeyDescriptionSourcesConstraintsDefaultValue
hostHostobj['host'], process.env['TCP_HOST']optional--
portPortobj['port'], process.env['TCP_PORT']optional--

Static configuration

KeyDescriptionConstraintsDefaultValue
defaultLoggerDefault logger for applicationoptional--
loggerSpecifies the logger to use. Pass false to turn off logging.optional--
abortOnErrorWhether to abort the process on Error. By default, the process is exited. Pass false to override the default behavior. If false is passed, Nest will not exit the application and instead will rethrow the exception. @default trueoptional--
bufferLogsIf enabled, logs will be buffered until the "Logger#flush" method is called. @default falseoptional--
autoFlushLogsIf enabled, logs will be automatically flushed and buffer detached when application initialization process either completes or fails. @default trueoptional--
previewWhether to run application in the preview mode. In the preview mode, providers/controllers are not instantiated & resolved. @default falseoptional--
snapshotWhether to generate a serialized graph snapshot. @default falseoptional--
featureNameFeature name for generate prefix to environments keysoptional--
microserviceProjectNameMicroservice project name for generate prefix to environments keys (need only for microservice client)optional--
retryAttemptsRetry attemptsoptional--
retryDelayRetry delayoptional--
serializerSerializeroptional--
tlsOptionsTLS optionsoptional--
deserializerDeserializeroptional--
socketClassSocket classoptional--

Back to Top


TcpNestMicroserviceClientModule

TCP NestJS-mod microservice client @see https://docs.nestjs.com/microservices/basics

Shared providers

TcpNestMicroserviceClient, ClientProxyApplicationHooks

Static environments

KeyDescriptionSourcesConstraintsDefaultValue
hostHostobj['host'], process.env['TCP_HOST']optional--
portPortobj['port'], process.env['TCP_PORT']optional--

Static configuration

KeyDescriptionConstraintsDefaultValue
defaultLoggerDefault logger for applicationoptional--
loggerSpecifies the logger to use. Pass false to turn off logging.optional--
abortOnErrorWhether to abort the process on Error. By default, the process is exited. Pass false to override the default behavior. If false is passed, Nest will not exit the application and instead will rethrow the exception. @default trueoptional--
bufferLogsIf enabled, logs will be buffered until the "Logger#flush" method is called. @default falseoptional--
autoFlushLogsIf enabled, logs will be automatically flushed and buffer detached when application initialization process either completes or fails. @default trueoptional--
previewWhether to run application in the preview mode. In the preview mode, providers/controllers are not instantiated & resolved. @default falseoptional--
snapshotWhether to generate a serialized graph snapshot. @default falseoptional--
featureNameFeature name for generate prefix to environments keysoptional--
microserviceProjectNameMicroservice project name for generate prefix to environments keys (need only for microservice client)optional--
retryAttemptsRetry attemptsoptional--
retryDelayRetry delayoptional--
serializerSerializeroptional--
tlsOptionsTLS optionsoptional--
deserializerDeserializeroptional--
socketClassSocket classoptional--

Back to Top

License

MIT