Loading docs/manual/federation.md +12 −12 Original line number Diff line number Diff line Loading @@ -51,16 +51,16 @@ testing and development purposes, and the `DenoKvStore` class is Deno KV-backed implementation for production use (as you can guess from the name, it is only available in Deno runtime). As separate packages, [@fedify/redis] provides [`RedisKvStore`] class, which is a Redis-backed implementation for production use, and [@fedify/postgres] As separate packages, [`@fedify/redis`] provides [`RedisKvStore`] class, which is a Redis-backed implementation for production use, and [`@fedify/postgres`] provides [`PostgresKvStore`] class, which is a PostgreSQL-backed implementation for production use. Further details are explained in the [*Key–value store* section](./kv.md). [@fedify/redis]: https://github.com/fedify-dev/redis [`@fedify/redis`]: https://github.com/fedify-dev/fedify/tree/main/packages/redis [`RedisKvStore`]: https://jsr.io/@fedify/redis/doc/kv/~/RedisKvStore [@fedify/postgres]: https://github.com/fedify-dev/postgres [`@fedify/postgres`]: https://github.com/fedify-dev/fedify/tree/main/packages/postgres [`PostgresKvStore`]: https://jsr.io/@fedify/postgres/doc/kv/~/PostgresKvStore ### `kvPrefixes` Loading Loading @@ -110,12 +110,12 @@ and the `DenoKvMessageQueue` class is a Deno KV-backed implementation for production use (as you can guess from the name, it is only available in Deno runtime). As separate packages, [@fedify/redis] provides [`RedisMessageQueue`] class, As separate packages, [`@fedify/redis`] provides [`RedisMessageQueue`] class, which is a Redis-backed implementation for production use, and [@fedify/postgres] provides [`PostgresMessageQueue`] class, which is a PostgreSQL-backed implementation for production use, and [@fedify/amqp] provides [`AmqpMessageQueue`] class, which is an AMQP broker-backed implementation for production use. and [`@fedify/postgres`] provides [`PostgresMessageQueue`] class, which is a PostgreSQL-backed implementation for production use, and [`@fedify/amqp`] provides [`AmqpMessageQueue`] class, which is an AMQP broker-backed implementation for production use. Further details are explained in the [*Message queue* section](./mq.md). Loading Loading @@ -184,7 +184,7 @@ Further details are explained in the [*Message queue* section](./mq.md). [`RedisMessageQueue`]: https://jsr.io/@fedify/redis/doc/mq/~/RedisMessageQueue [`PostgresMessageQueue`]: https://jsr.io/@fedify/postgres/doc/mq/~/PostgresMessageQueue [@fedify/amqp]: https://github.com/fedify-dev/amqp [`@fedify/amqp`]: https://github.com/fedify-dev/fedify/tree/main/packages/amqp [`AmqpMessageQueue`]: https://jsr.io/@fedify/amqp/doc/mq/~/AmqpMessageQueue ### `manuallyStartQueue` Loading Loading @@ -305,8 +305,8 @@ an object for options. > [!CAUTION] > > This settings do not affect the `User-Agent` header of the HTTP requests > that `lookupWebFinger()`, `lookupObject()`, and `getNodeInfo()` functions make, > since they do not depend on the `Federation` object. > that `lookupWebFinger()`, `lookupObject()`, and `getNodeInfo()` functions > make, since they do not depend on the `Federation` object. > > However, `Context.lookupObject()` method is affected by this settings. Loading docs/manual/inbox.md +1 −1 Original line number Diff line number Diff line Loading @@ -381,7 +381,7 @@ duplicate retry mechanisms and leverages the backend's optimized retry features. [`DenoKvMessageQueue`]: https://jsr.io/@fedify/denokv/doc/mq/~/DenoKvMessageQueue [`@fedify/denokv`]: https://github.com/fedify-dev/fedify/tree/main/packages/denokv [`RedisMessageQueue`]: https://jsr.io/@fedify/redis/doc/mq/~/RedisMessageQueue [`@fedify/redis`]: https://github.com/fedify-dev/redis [`@fedify/redis`]: https://github.com/fedify-dev/fedify/tree/main/packages/redis Error handling Loading docs/tutorial/basics.md +4 −4 Original line number Diff line number Diff line Loading @@ -252,8 +252,8 @@ a key–value store. > [!IMPORTANT] > Since `MemoryKvStore` is for testing and development purposes, you should > use a persistent key–value store like `DenoKvStore` (in Deno) or > [`RedisKvStore`] (from [@fedify/redis] package) or [`PostgresKvStore`] > (from [@fedify/postgres] package) for production use. > [`RedisKvStore`] (from [`@fedify/redis`] package) or [`PostgresKvStore`] > (from [`@fedify/postgres`] package) for production use. > > For further details, see the [*Key–value store* section](../manual/kv.md). Loading Loading @@ -353,9 +353,9 @@ to the next step. > }); > ~~~~ [@fedify/redis]: https://github.com/fedify-dev/redis [`@fedify/redis`]: https://github.com/fedify-dev/fedify/tree/main/packages/redis [`RedisKvStore`]: https://jsr.io/@fedify/redis/doc/kv/~/RedisKvStore [@fedify/postgres]: https://github.com/fedify-dev/postgres [`@fedify/postgres`]: https://github.com/fedify-dev/fedify/tree/main/packages/postgres [`PostgresKvStore`]: https://jsr.io/@fedify/postgres/doc/kv/~/PostgresKvStore [LogTape]: https://logtape.org/ [`configure()`]: https://jsr.io/@logtape/logtape/doc/~/configure Loading packages/redis/README.md +0 −3 Original line number Diff line number Diff line Loading @@ -5,7 +5,6 @@ [![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: Loading Loading @@ -43,8 +42,6 @@ const federation = createFederation({ [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/fedify-dev/redis/actions/workflows/main.yaml [GitHub Actions badge]: https://github.com/fedify-dev/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 Loading Loading
docs/manual/federation.md +12 −12 Original line number Diff line number Diff line Loading @@ -51,16 +51,16 @@ testing and development purposes, and the `DenoKvStore` class is Deno KV-backed implementation for production use (as you can guess from the name, it is only available in Deno runtime). As separate packages, [@fedify/redis] provides [`RedisKvStore`] class, which is a Redis-backed implementation for production use, and [@fedify/postgres] As separate packages, [`@fedify/redis`] provides [`RedisKvStore`] class, which is a Redis-backed implementation for production use, and [`@fedify/postgres`] provides [`PostgresKvStore`] class, which is a PostgreSQL-backed implementation for production use. Further details are explained in the [*Key–value store* section](./kv.md). [@fedify/redis]: https://github.com/fedify-dev/redis [`@fedify/redis`]: https://github.com/fedify-dev/fedify/tree/main/packages/redis [`RedisKvStore`]: https://jsr.io/@fedify/redis/doc/kv/~/RedisKvStore [@fedify/postgres]: https://github.com/fedify-dev/postgres [`@fedify/postgres`]: https://github.com/fedify-dev/fedify/tree/main/packages/postgres [`PostgresKvStore`]: https://jsr.io/@fedify/postgres/doc/kv/~/PostgresKvStore ### `kvPrefixes` Loading Loading @@ -110,12 +110,12 @@ and the `DenoKvMessageQueue` class is a Deno KV-backed implementation for production use (as you can guess from the name, it is only available in Deno runtime). As separate packages, [@fedify/redis] provides [`RedisMessageQueue`] class, As separate packages, [`@fedify/redis`] provides [`RedisMessageQueue`] class, which is a Redis-backed implementation for production use, and [@fedify/postgres] provides [`PostgresMessageQueue`] class, which is a PostgreSQL-backed implementation for production use, and [@fedify/amqp] provides [`AmqpMessageQueue`] class, which is an AMQP broker-backed implementation for production use. and [`@fedify/postgres`] provides [`PostgresMessageQueue`] class, which is a PostgreSQL-backed implementation for production use, and [`@fedify/amqp`] provides [`AmqpMessageQueue`] class, which is an AMQP broker-backed implementation for production use. Further details are explained in the [*Message queue* section](./mq.md). Loading Loading @@ -184,7 +184,7 @@ Further details are explained in the [*Message queue* section](./mq.md). [`RedisMessageQueue`]: https://jsr.io/@fedify/redis/doc/mq/~/RedisMessageQueue [`PostgresMessageQueue`]: https://jsr.io/@fedify/postgres/doc/mq/~/PostgresMessageQueue [@fedify/amqp]: https://github.com/fedify-dev/amqp [`@fedify/amqp`]: https://github.com/fedify-dev/fedify/tree/main/packages/amqp [`AmqpMessageQueue`]: https://jsr.io/@fedify/amqp/doc/mq/~/AmqpMessageQueue ### `manuallyStartQueue` Loading Loading @@ -305,8 +305,8 @@ an object for options. > [!CAUTION] > > This settings do not affect the `User-Agent` header of the HTTP requests > that `lookupWebFinger()`, `lookupObject()`, and `getNodeInfo()` functions make, > since they do not depend on the `Federation` object. > that `lookupWebFinger()`, `lookupObject()`, and `getNodeInfo()` functions > make, since they do not depend on the `Federation` object. > > However, `Context.lookupObject()` method is affected by this settings. Loading
docs/manual/inbox.md +1 −1 Original line number Diff line number Diff line Loading @@ -381,7 +381,7 @@ duplicate retry mechanisms and leverages the backend's optimized retry features. [`DenoKvMessageQueue`]: https://jsr.io/@fedify/denokv/doc/mq/~/DenoKvMessageQueue [`@fedify/denokv`]: https://github.com/fedify-dev/fedify/tree/main/packages/denokv [`RedisMessageQueue`]: https://jsr.io/@fedify/redis/doc/mq/~/RedisMessageQueue [`@fedify/redis`]: https://github.com/fedify-dev/redis [`@fedify/redis`]: https://github.com/fedify-dev/fedify/tree/main/packages/redis Error handling Loading
docs/tutorial/basics.md +4 −4 Original line number Diff line number Diff line Loading @@ -252,8 +252,8 @@ a key–value store. > [!IMPORTANT] > Since `MemoryKvStore` is for testing and development purposes, you should > use a persistent key–value store like `DenoKvStore` (in Deno) or > [`RedisKvStore`] (from [@fedify/redis] package) or [`PostgresKvStore`] > (from [@fedify/postgres] package) for production use. > [`RedisKvStore`] (from [`@fedify/redis`] package) or [`PostgresKvStore`] > (from [`@fedify/postgres`] package) for production use. > > For further details, see the [*Key–value store* section](../manual/kv.md). Loading Loading @@ -353,9 +353,9 @@ to the next step. > }); > ~~~~ [@fedify/redis]: https://github.com/fedify-dev/redis [`@fedify/redis`]: https://github.com/fedify-dev/fedify/tree/main/packages/redis [`RedisKvStore`]: https://jsr.io/@fedify/redis/doc/kv/~/RedisKvStore [@fedify/postgres]: https://github.com/fedify-dev/postgres [`@fedify/postgres`]: https://github.com/fedify-dev/fedify/tree/main/packages/postgres [`PostgresKvStore`]: https://jsr.io/@fedify/postgres/doc/kv/~/PostgresKvStore [LogTape]: https://logtape.org/ [`configure()`]: https://jsr.io/@logtape/logtape/doc/~/configure Loading
packages/redis/README.md +0 −3 Original line number Diff line number Diff line Loading @@ -5,7 +5,6 @@ [![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: Loading Loading @@ -43,8 +42,6 @@ const federation = createFederation({ [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/fedify-dev/redis/actions/workflows/main.yaml [GitHub Actions badge]: https://github.com/fedify-dev/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 Loading