Home > @imqueue/core

core package

Classes

Class

Description

ClusteredRedisQueue

Class ClusteredRedisQueue Implements the possibility to scale queues horizontally between several redis instances.

IMQ

Message Queue Factory

RedisQueue

Class RedisQueue Implements a simple messaging queue over redis.

UDPClusterManager

Enumerations

Enumeration

Description

IMQMode

LogLevel

Functions

Function

Description

logDebugInfo({ debugTime, debugArgs, className, args, methodName, start, logger, logLevel, }, input)

Logs debug information about a function call

profile(options)

Implements '@profile' decorator.

verifyLogLevel(level)

Validates a log level value or returns the default

Interfaces

Interface

Description

DebugInfoOptions

EventMap

ILogger

Logger interface

IMessage

Defines a message format.

{IMessage}

IMessageQueue

Generic messaging queue implementation interface

IMessageQueueAuthConnection

IMessageQueueConnection

IMQOptions

Message queue options

IRedisClient

Extends the default Redis type to allow dynamic properties access on it

{IRedisClient}

IServerInput

JsonArray

Represents JSON-serializable array

JsonObject

Represents JSON serializable object

ProfileDecoratorOptions

UDPClusterManagerOptions

Variables

Variable

Description

DEFAULT_IMQ_OPTIONS

DEFAULT_UDP_CLUSTER_MANAGER_OPTIONS

IMQ_CONNECTION_QUIT_TIMEOUT

Grace period (ms) for a graceful QUIT to complete before a channel is forcibly disconnected. A reader blocked on an infinite BRPOP/BLMOVE can never let QUIT through, so without this the socket would leak and keep the process alive.

IMQ_LOG_ARGS

Environment variable IMQ_LOG_ARGS=[1, 0]. Enable or disable logging of profiled call arguments.

{boolean}

IMQ_LOG_LEVEL

IMQ_LOG_TIME_FORMAT

Environment variable IMQ_LOG_TIME_FORMAT. Specifies the format for profiled time logging. Values: 'microseconds', 'milliseconds', 'seconds'. Default: 'microseconds'

{AllowedTimeFormat | string}

IMQ_LOG_TIME

Environment variable IMQ_LOG_TIME=[1, 0]. Enable or disable profiled timing logging.

{boolean}

IMQ_SHUTDOWN_TIMEOUT

Type Aliases

Type Alias

Description

AllowedTimeFormat

AnyJson

Represents any JSON-serializable value

IMessageQueueConstructor

UDPWorkerOptions

Subset of the manager options handed over to the UDP worker thread. Only structured-cloneable values may appear here (no logger).