UNPKG

redis-smq-common

Version:

Provides essential components and utilities shared across RedisSMQ packages.

github.com/weyoss/redis-smq

weyoss/redis-smq

65 lines (42 loc) • 2.45 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# RedisSMQ Common Library __NPM_BADGE__ __CODECOV_BADGE__ __IS_NEXT_NOTE__ 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: ```bash npm install redis-smq-common__TAG_SUFFIX__ # or pnpm add redis-smq-common__TAG_SUFFIX__ ``` This package works with multiple Redis clients. Install one of the supported clients based on your needs: - ioredis (recommended for advanced features) ```shell npm install ioredis ``` - @redis/client (official Redis client) ```shell 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](https://github.com/weyoss/redis-smq/tree/__BRANCH_NAME__/packages/redis-smq/docs/version-compatibility.md) for details. ## Documentation For in-depth guides and API references, see [the documentation page](https://github.com/weyoss/redis-smq/tree/__BRANCH_NAME__/packages/redis-smq-common/docs/README.md). ## Related packages - [redis-smq](https://github.com/weyoss/redis-smq/tree/__BRANCH_NAME__/packages/redis-smq/README.md): Core message queue for Node.js - [redis-smq-rest-api](https://github.com/weyoss/redis-smq/tree/__BRANCH_NAME__/packages/redis-smq-rest-api/README.md): REST API with OpenAPI v3 and Swagger UI - [redis-smq-web-server](https://github.com/weyoss/redis-smq/tree/__BRANCH_NAME__/packages/redis-smq-web-server/README.md): Web server for hosting the UI and proxying/serving the API - [redis-smq-web-ui](https://github.com/weyoss/redis-smq/tree/__BRANCH_NAME__/packages/redis-smq-web-ui/README.md): SPA for monitoring and managing RedisSMQ ## License RedisSMQ Common Library is released under the [MIT License](https://github.com/weyoss/redis-smq/tree/__BRANCH_NAME__/LICENSE).