@adonis-agora/agent/dist/src/redis-stream-client.d.ts

Governed, durable-backed AI agent (chat + tool-calling + governance) for AdonisJS — part of the Agora ecosystem.

/**
 * The minimal Redis surface {@link import('./redis-token-stream-sink.js').RedisTokenStreamSink} needs.
 *
 * The host adapts its own driver (`@adonisjs/redis` / `ioredis`) to this interface — so this package
 * pulls in NO Redis driver of its own (bring your own, exactly like the Lucid store adapters take a
 * database handle). The `tokenSinks.redis()` factory ships an adapter over `@adonisjs/redis` that it
 * imports lazily, so the driver only loads when the Redis sink is actually selected.
 *
 * NOTE: `subscribe` needs a connection in subscriber mode; most drivers require a DEDICATED connection
 * for that (a subscribed client can't run other commands). An adapter should use a separate connection
 * for `subscribe` — the sink only calls `subscribe` from its own `subscribe()`.
 */
export interface RedisStreamClient {
    /** Append `value` to the list at `key` (RPUSH). */
    rpush(key: string, value: string): Promise<void>;
    /** The list elements at `key` from `start` to `stop` inclusive; negative indices count from the end (LRANGE). */
    lrange(key: string, start: number, stop: number): Promise<string[]>;
    /** Set `key` to `value` (SET) — used for the terminal marker. */
    set(key: string, value: string): Promise<void>;
    /** The value at `key`, or `null` if unset (GET). */
    get(key: string): Promise<string | null>;
    /** Publish `message` on `channel` (PUBLISH). */
    publish(channel: string, message: string): Promise<void>;
    /** Subscribe to `channel`, invoking `onMessage` per message. Resolves to an unsubscribe function. */
    subscribe(channel: string, onMessage: (message: string) => void): Promise<() => Promise<void>>;
    /** Delete the given keys (DEL). */
    del(...keys: string[]): Promise<void>;
    /**
     * Set a TTL of `seconds` on `key` so it self-expires (EXPIRE). Optional: a bring-your-own client that
     * omits it keeps the sink working, the run's keys just retain until `close()` or manual cleanup. The
     * `@adonisjs/redis` adapter always provides it, so the default Redis sink bounds every run's keys.
     */
    expire?(key: string, seconds: number): Promise<void>;
}
//# sourceMappingURL=redis-stream-client.d.ts.map