@kurrent/kurrentdb-client/dist/persistentSubscription/subscribeToPersistentSubscriptionToStream.d.ts

KurrentDB gRPC NodeJS Client SDK

import type { DuplexOptions } from "stream";
import type { PersistentSubscriptionToStream, BaseOptions, EventType } from "../types";
export interface SubscribeToPersistentSubscriptionToStreamOptions extends BaseOptions {
    /**
     * The buffer size to use for the persistent subscription.
     * @defaultValue 10
     */
    bufferSize?: number;
}
declare module "../Client" {
    interface Client {
        /**
         * Connects to a persistent subscription.
         * @param stream - A stream name.
         * @param group - A group name.
         * @param options - Connection options.
         */
        subscribeToPersistentSubscriptionToStream<E extends EventType = EventType>(streamName: string, groupName: string, options?: SubscribeToPersistentSubscriptionToStreamOptions, duplexOptions?: DuplexOptions): PersistentSubscriptionToStream<E>;
    }
}