https://github.com/myunisoft/redis

TypeScript Redis abstraction we use in backend at MyUnisoft
https://github.com/myunisoft/redis

redis

Last synced: about 1 year ago
JSON representation

TypeScript Redis abstraction we use in backend at MyUnisoft

• Host: GitHub
• URL: https://github.com/myunisoft/redis
• Owner: MyUnisoft
• License: mit
• Created: 2022-09-07T14:33:25.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2025-05-01T02:02:39.000Z (about 1 year ago)
• Last Synced: 2025-05-01T03:19:27.596Z (about 1 year ago)
• Topics: redis
• Language: TypeScript
• Homepage:
• Size: 1.48 MB
• Stars: 5
• Watchers: 0
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  Redis





  MyUnisoft Redis package.





    

    

    



## 🚧 Requirements

- [Node.js](https://nodejs.org/en/) version 20 or higher.

- Docker (for running tests).

> [!TIP]

> If you ever want to setup a local instance of Redis,  

> you can follow the [Redis documentation](https://redis.io/docs/getting-started/) for Mac,  

> or, you can use [Memurai](https://www.memurai.com/) for Windows.

## 🚀 Getting Started

This package is available in the Node Package Repository and can be easily installed with [npm](https://docs.npmjs.com/getting-started/what-is-npm) or [yarn](https://yarnpkg.com).

```bash

$ npm i @myunisoft/redis

# or

$ yarn add @myunisoft/redis

```

---



  There are multiple adapters to exploit the different abstractions available.



- Adapter

  - [MemoryAdapter](./docs/adapter/memory.adapter.md)

  - [RedisAdapter](./docs/adapter/redis.adapter.md)

- Abstraction

  - [KVPeer](./docs/KVPeer.md)

  - [TimedKVPeer](./docs/TimedKVPeer.md)

  - [StoreContext](./docs/StoreContext.md)

  - [PubSub](./docs/pubsub/Channel.md)

  - [Stream](./docs/stream/Stream.md)

    - [Intrapersonal](./docs/stream/Intrapersonal.md)

    - [Interpersonal](./docs/stream/Interpersonal.md)

## Contributors ✨

[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
Nicolas Hallaert
💻 ⚠️ 📖 👀

      
PierreDemailly
👀 ⚠️

      
Thomas.G
💻 ⚠️ 📖 👀

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!