https://github.com/dahlia/fedify-redis

Redis drivers for Fedify
https://github.com/dahlia/fedify-redis

fedify redis

Last synced: 12 days ago
JSON representation

Redis drivers for Fedify

• Host: GitHub
• URL: https://github.com/dahlia/fedify-redis
• Owner: dahlia
• License: mit
• Created: 2024-06-19T13:20:42.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-10-03T17:46:03.000Z (4 months ago)
• Last Synced: 2024-12-31T05:09:52.251Z (17 days ago)
• Topics: fedify, redis
• Language: TypeScript
• Homepage: https://jsr.io/@fedify/redis
• Size: 64.5 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


@fedify/redis: Redis drivers for Fedify

=======================================

[![JSR][JSR badge]][JSR]

[![npm][npm badge]][npm]

[![GitHub Actions][GitHub Actions badge]][GitHub Actions]

This package provides [Fedify]'s [`KvStore`] and [`MessageQueue`]

implementations for Redis:

 -  [`RedisKvStore`]

 -  [`RedisMessageQueue`]

~~~~ typescript

import { createFederation } from "@fedify/fedify";

import { RedisKvStore, RedisMessageQueue } from "@fedify/redis";

import { Redis } from "ioredis";

const federation = createFederation({

  kv: new RedisKvStore(new Redis()),

  queue: new RedisMessageQueue(() => new Redis()),

});

~~~~

[JSR]: https://jsr.io/@fedify/redis

[JSR badge]: https://jsr.io/badges/@fedify/redis

[npm]: https://www.npmjs.com/package/@fedify/redis

[npm badge]: https://img.shields.io/npm/v/@fedify/redis?logo=npm

[GitHub Actions]: https://github.com/dahlia/fedify-redis/actions/workflows/main.yaml

[GitHub Actions badge]: https://github.com/dahlia/fedify-redis/actions/workflows/main.yaml/badge.svg

[Fedify]: https://fedify.dev/

[`KvStore`]: https://jsr.io/@fedify/fedify/doc/federation/~/KvStore

[`MessageQueue`]: https://jsr.io/@fedify/fedify/doc/federation/~/MessageQueue

[`RedisKvStore`]: https://jsr.io/@fedify/redis/doc/kv/~/RedisKvStore

[`RedisMessageQueue`]: https://jsr.io/@fedify/redis/doc/mq/~/RedisMessageQueue

Installation

------------

### Deno

~~~~ sh

deno add @fedify/redis

~~~~

### Node.js

~~~~ sh

npm install @fedify/redis

~~~~

### Bun

~~~~ sh

bun add @fedify/redis

~~~~

Changelog

---------

### Version 0.4.0

To be released.

### Version 0.3.0

Released on October 4, 2024.

 -  Polling is now more efficient.

 -  Renamed `RedisMessageQueueOptions.loopInterval` option to `pollInterval`

    option.

### Version 0.2.0

Released on September 26, 2024.

 -  Let `RedisMessageQueue` follow up the latest `MessageQueue` interface,

    which was updated in Fedify 1.0.0.

 -  Added some example code.

### Version 0.1.1

Released on June 22, 2024.

 -  Exported `@fedify/redis/mq` module.

### Version 0.1.0

Initial release.  Released on June 22, 2024.