mrsrv7 / redis-om-commonjs Goto Github PK

Object mapping, and more, for Redis and Node.js. Written in TypeScript.

Checkout Redis, redis-om

⚠️ Warning: This Version Has Breaking Changes from 0.3.6

Redis OM 0.4 is new, improved, and includes breaking changes. If you're trying it for the first time, no worries. Just follow what's in this README and you'll be fine.

However, you might be a user of Redis OM already. If that is the case, you'll want to review this document to understand those changes.

Of course, you don't have to upgrade. If this is you, you'll want to check out the README for that version over on NPM.

However, I hope you choose to try the new version. It has many changes that have been frequently requested that are documented in the CHANGELOG. And more, non-breaking changes will follow these.

This is an example NodeJS application on how to use redis-om in the CommonJS approach. As I worked on a legacy NodeJS app written in CommonJS Syntax, I could not use the Module approach (like import, top-level await, etc.), so this is how I implemented redis-om in the legacy NodeJS app. Please let me know if there is anything that can be implemented better.

This example application is made with redis-om-node-tutorial as a base.

I have added the Postman API Collection JSON for a quick setup when testing the REST API endpoints. Check out the Redis OM CommonJS API.json in the root folder. This application can be used as a template if you need to implement redis-om in a legacy CommonJS application or planning to create a new CommonJS application.

This is not an official CommonJS solution for implementing redis-om. I implemented this as a workaround as there is no proper documentation for implementing the same yet. Also, this might feel highly opinionated as I created the app completely based on my coding style (creating the controllers, routes, helpers, etc.)