Helpers
Reusable classes and functions providing common functionality - designed for easy injection and configuration.
Available Helpers
| Helper | Purpose | Key Features |
|---|---|---|
| Common Types | Utility types | Nullable, resolvers, class types |
| Cron | Job scheduling | Cron expressions, task management |
| Crypto | Cryptographic operations | AES/RSA/ECDH encryption, key exchange, hashing |
| Environment | Environment variables | Centralized config access |
| Error | Error handling | ApplicationError, consistent responses |
| Inversion | Dependency injection | DI container implementation |
| Logger | Logging | Winston-based, multiple transports, scopes |
| Network | Network requests | HTTP, TCP, UDP helpers |
| Kafka | Event streaming | Apache Kafka producer/consumer/admin/schema registry |
| Queue | Message queues | BullMQ, MQTT support |
| Redis | Redis operations | Single/cluster, key-value, hashes, JSON, pub/sub |
| Socket.IO | Real-time communication | Socket.IO client/server helpers |
| WebSocket | Real-time communication | Bun native WebSocket server/emitter, Redis scaling |
| Storage | File storage | In-memory, Minio object storage |
| Testing | Test utilities | Test plan runner, base test classes |
| UID | Unique ID generation | Snowflake IDs, Base62 encoding |
| Worker Thread | Worker threads | Node.js worker management |
Subpath Imports
Some helpers with optional peer dependencies are only available via subpath imports to ensure proper tree-shaking:
| Subpath | Peer Dependency | Description |
|---|---|---|
@venizia/ignis-helpers/kafka | @platformatic/kafka | Kafka producer/consumer/admin/schema registry |
@venizia/ignis-helpers/bullmq | bullmq | BullMQ job queue |
@venizia/ignis-helpers/mqtt | mqtt | MQTT pub/sub client |
@venizia/ignis-helpers/socket-io | socket.io, socket.io-client | Socket.IO server/client |
@venizia/ignis-helpers/minio | minio | MinIO S3-compatible storage |
@venizia/ignis-helpers/bun-s3 | -- | Bun native S3 storage |
@venizia/ignis-helpers/cron | cron | Cron job scheduling |
@venizia/ignis-helpers/axios | axios | Axios HTTP client |
See Also
Related Concepts:
- Services - Using helpers in service layer
- Controllers - Using helpers in controllers
References:
- Utilities - Pure utility functions
- Components - Framework components