README.md

RedisSMQ Common Library

💡 Note: You are viewing the next branch with upcoming features. For stable releases, check the master branch.

A shared foundation for the RedisSMQ ecosystem. This package provides essential components and utilities used by RedisSMQ and related packages, helping you configure Redis clients, structure logging, and reuse core types across the stack.

Features

• Core types and utilities shared across RedisSMQ packages
• Configuration helpers and enums (e.g., select Redis client implementation)
• Logging interfaces and a Console logger implementation
• Redis client abstractions and guidance for supported clients
• File-based synchronization primitives (e.g., FileLock)
• Thorough documentation for server/client setup and usage

Installation

Install the package:

npm install redis-smq-common@next
# or
pnpm add redis-smq-common@next

This package works with multiple Redis clients. Install one of the supported clients based on your needs:

• ioredis (recommended for advanced features)

npm install ioredis

• @redis/client (official Redis client)

npm install @redis/client

Note: Redis clients are optional peer dependencies; pick one and configure it in your application.

Version compatibility

Always install matching versions of RedisSMQ packages to ensure compatibility. See version compatibility for details.

Documentation

For in-depth guides and API references, see the documentation page.

Related packages

• redis-smq: Core message queue for Node.js
• redis-smq-rest-api: REST API with OpenAPI v3 and Swagger UI
• redis-smq-web-server: Web server for hosting the UI and proxying/serving the API
• redis-smq-web-ui: SPA for monitoring and managing RedisSMQ

License

RedisSMQ Common Library is released under the MIT License.