Qified - @qified/valkey

Valkey message provider for Qified.

This package implements a message provider backed by Valkey using the Valkey publish/subscribe commands. It is built on the iovalkey client and, because Valkey is wire-compatible with Redis, connects using redis:// URIs.

Installation
Usage with Qified
API
Contributing
License

Installation

pnpm add @qified/valkey

Usage with Qified

import { createQified } from "@qified/valkey";
import type { Message } from "qified";

const qified = createQified({ uri: "redis://localhost:6380" });

await qified.subscribe("example-topic", {
        async handler(message: Message) {
                console.log(message);
        },
});

await qified.publish("example-topic", { id: "1", data: "Hello from Valkey!" });

await qified.disconnect();

API

ValkeyMessageProviderOptions

Configuration options for the Valkey message provider.

uri?: Valkey connection URI. Defaults to defaultValkeyUri.

defaultValkeyUri

Default Valkey connection string ("redis://localhost:6380").

ValkeyMessageProvider

Implements the MessageProvider interface using Valkey pub/sub.

constructor(options?: ValkeyMessageProviderOptions)

Creates a new provider.

Options:

uri: Valkey connection URI (defaults to "redis://localhost:6380").

publish(topic: string, message: Message)

Publishes a message to a topic.

subscribe(topic: string, handler: TopicHandler)

Subscribes a handler to a topic.

unsubscribe(topic: string, id?: string)

Unsubscribes a handler by id or all handlers for a topic.

disconnect()

Disconnects the underlying Valkey clients and clears all subscriptions.

createQified(options?: ValkeyMessageProviderOptions)

Convenience factory that returns a Qified instance configured with ValkeyMessageProvider.

Contributing

Contributions are welcome! Please read the CONTRIBUTING.md and CODE_OF_CONDUCT.md for details on our process.

Table of Contents