wrappers/README.md

10 lines
669 B
Markdown
Raw Normal View History

2023-04-12 10:34:41 +02:00
# wrappers
2023-04-12 13:23:41 +02:00
Various wrapper classes I use in my projects.
These are specifically written for my use cases, though feel free to use.
MessageBroker: Wraps `amqp-connection-manager` and `amqplib` by extension. Ensures smooth failover when connected to a cluster.
MariaDB: Wraps `mysql`. Takes care of connection pooling whether connecting to a cluster or single instance.
MongoDB: Wraps `mongodb`. Primarily just adds helper functions.
Expected to be used together with a parent class that has a `createLogger` method, as defined in `/src/interfaces/Server.ts` and `/src/interfaces/Logger.ts`, utilising the logger from https://git.corgi.wtf/Navy.gif/logger.