langchain 0.0.131 → 0.0.132

package/dist/schema/output_parser.js

@@ -1,8 +1,31 @@
 import { Runnable } from "./runnable.js";
+/**
+ * Abstract base class for parsing the output of a Large Language Model
+ * (LLM) call. It provides methods for parsing the result of an LLM call
+ * and invoking the parser with a given input.
+ */
 export class BaseLLMOutputParser extends Runnable {
+    /**
+     * Parses the result of an LLM call with a given prompt. By default, it
+     * simply calls `parseResult`.
+     * @param generations The generations from an LLM call.
+     * @param _prompt The prompt used in the LLM call.
+     * @param callbacks Optional callbacks.
+     * @returns A promise of the parsed output.
+     */
     parseResultWithPrompt(generations, _prompt, callbacks) {
         return this.parseResult(generations, callbacks);
     }
+    /**
+     * Calls the parser with a given input and optional configuration options.
+     * If the input is a string, it creates a generation with the input as
+     * text and calls `parseResult`. If the input is a `BaseMessage`, it
+     * creates a generation with the input as a message and the content of the
+     * input as text, and then calls `parseResult`.
+     * @param input The input to the parser, which can be a string or a `BaseMessage`.
+     * @param options Optional configuration options.
+     * @returns A promise of the parsed output.
+     */
     async invoke(input, options) {
         if (typeof input === "string") {
             return this._callWithConfig(async (input) => this.parseResult([{ text: input }]), input, { ...options, runType: "parser" });
@@ -43,6 +66,13 @@ export class BaseTransformOutputParser extends BaseOutputParser {
             }
         }
     }
+    /**
+     * Transforms an asynchronous generator of input into an asynchronous
+     * generator of parsed output.
+     * @param inputGenerator An asynchronous generator of input.
+     * @param options A configuration object.
+     * @returns An asynchronous generator of parsed output.
+     */
     async *transform(inputGenerator, options) {
         yield* this._streamWithConfig(this._transform(inputGenerator), {
             ...options,
@@ -72,6 +102,14 @@ export class StringOutputParser extends BaseTransformOutputParser {
     static lc_name() {
         return "StrOutputParser";
     }
+    /**
+     * Parses a string output from an LLM call. This method is meant to be
+     * implemented by subclasses to define how a string output from an LLM
+     * should be parsed.
+     * @param text The string output from an LLM call.
+     * @param callbacks Optional callbacks.
+     * @returns A promise of the parsed output.
+     */
     parse(text) {
         return Promise.resolve(text);
     }
@@ -115,6 +153,11 @@ export class BytesOutputParser extends BaseTransformOutputParser {
         return "";
     }
 }
+/**
+ * Custom error class used to handle exceptions related to output parsing.
+ * It extends the built-in `Error` class and adds an optional `output`
+ * property that can hold the output that caused the exception.
+ */
 export class OutputParserException extends Error {
     constructor(message, output) {
         super(message);

package/dist/schema/query_constructor.cjs

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AttributeInfo = void 0;
+/**
+ * A simple data structure that holds information about an attribute. It
+ * is typically used to provide metadata about attributes in other classes
+ * or data structures within the LangChain framework.
+ */
 class AttributeInfo {
     constructor(name, type, description) {
         Object.defineProperty(this, "name", {

package/dist/schema/query_constructor.d.ts

@@ -1,3 +1,8 @@
+/**
+ * A simple data structure that holds information about an attribute. It
+ * is typically used to provide metadata about attributes in other classes
+ * or data structures within the LangChain framework.
+ */
 export declare class AttributeInfo {
     name: string;
     type: string;

package/dist/schema/query_constructor.js

@@ -1,3 +1,8 @@
+/**
+ * A simple data structure that holds information about an attribute. It
+ * is typically used to provide metadata about attributes in other classes
+ * or data structures within the LangChain framework.
+ */
 export class AttributeInfo {
     constructor(name, type, description) {
         Object.defineProperty(this, "name", {

package/dist/schema/retriever.cjs

@@ -3,6 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseRetriever = void 0;
 const manager_js_1 = require("../callbacks/manager.cjs");
 const runnable_js_1 = require("./runnable.cjs");
+/**
+ * Abstract base class for a Document retrieval system. A retrieval system
+ * is defined as something that can take string queries and return the
+ * most 'relevant' Documents from some source. It extends the `Runnable`
+ * class, which means it is a unit of work that can be invoked, batched,
+ * streamed, or transformed. In the context of `BaseRetriever`, it is
+ * invoked with a string input and returns an array of `Document` objects.
+ */
 class BaseRetriever extends runnable_js_1.Runnable {
     constructor(fields) {
         super(fields);
@@ -46,6 +54,16 @@ class BaseRetriever extends runnable_js_1.Runnable {
     async invoke(input, options) {
         return this.getRelevantDocuments(input, options);
     }
+    /**
+     * Main method used to retrieve relevant documents. It takes a query
+     * string and an optional configuration object, and returns a promise that
+     * resolves to an array of `Document` objects. This method handles the
+     * retrieval process, including starting and ending callbacks, and error
+     * handling.
+     * @param query The query string to retrieve relevant documents for.
+     * @param config Optional configuration object for the retrieval process.
+     * @returns A promise that resolves to an array of `Document` objects.
+     */
     async getRelevantDocuments(query, config) {
         const parsedConfig = (0, manager_js_1.parseCallbackConfigArg)(config);
         const callbackManager_ = await manager_js_1.CallbackManager.configure(parsedConfig.callbacks, this.callbacks, parsedConfig.tags, this.tags, parsedConfig.metadata, this.metadata, { verbose: this.verbose });

package/dist/schema/retriever.d.ts

@@ -10,6 +10,14 @@ export interface BaseRetrieverInput {
     metadata?: Record<string, unknown>;
     verbose?: boolean;
 }
+/**
+ * Abstract base class for a Document retrieval system. A retrieval system
+ * is defined as something that can take string queries and return the
+ * most 'relevant' Documents from some source. It extends the `Runnable`
+ * class, which means it is a unit of work that can be invoked, batched,
+ * streamed, or transformed. In the context of `BaseRetriever`, it is
+ * invoked with a string input and returns an array of `Document` objects.
+ */
 export declare abstract class BaseRetriever extends Runnable<string, Document[]> {
     callbacks?: Callbacks;
     tags?: string[];
@@ -23,5 +31,15 @@ export declare abstract class BaseRetriever extends Runnable<string, Document[]>
      */
     _getRelevantDocuments(_query: string, _callbacks?: CallbackManagerForRetrieverRun): Promise<Document[]>;
     invoke(input: string, options?: RunnableConfig): Promise<Document[]>;
+    /**
+     * Main method used to retrieve relevant documents. It takes a query
+     * string and an optional configuration object, and returns a promise that
+     * resolves to an array of `Document` objects. This method handles the
+     * retrieval process, including starting and ending callbacks, and error
+     * handling.
+     * @param query The query string to retrieve relevant documents for.
+     * @param config Optional configuration object for the retrieval process.
+     * @returns A promise that resolves to an array of `Document` objects.
+     */
     getRelevantDocuments(query: string, config?: Callbacks | BaseCallbackConfig): Promise<Document[]>;
 }

package/dist/schema/retriever.js

@@ -1,5 +1,13 @@
 import { CallbackManager, parseCallbackConfigArg, } from "../callbacks/manager.js";
 import { Runnable } from "./runnable.js";
+/**
+ * Abstract base class for a Document retrieval system. A retrieval system
+ * is defined as something that can take string queries and return the
+ * most 'relevant' Documents from some source. It extends the `Runnable`
+ * class, which means it is a unit of work that can be invoked, batched,
+ * streamed, or transformed. In the context of `BaseRetriever`, it is
+ * invoked with a string input and returns an array of `Document` objects.
+ */
 export class BaseRetriever extends Runnable {
     constructor(fields) {
         super(fields);
@@ -43,6 +51,16 @@ export class BaseRetriever extends Runnable {
     async invoke(input, options) {
         return this.getRelevantDocuments(input, options);
     }
+    /**
+     * Main method used to retrieve relevant documents. It takes a query
+     * string and an optional configuration object, and returns a promise that
+     * resolves to an array of `Document` objects. This method handles the
+     * retrieval process, including starting and ending callbacks, and error
+     * handling.
+     * @param query The query string to retrieve relevant documents for.
+     * @param config Optional configuration object for the retrieval process.
+     * @returns A promise that resolves to an array of `Document` objects.
+     */
     async getRelevantDocuments(query, config) {
         const parsedConfig = parseCallbackConfigArg(config);
         const callbackManager_ = await CallbackManager.configure(parsedConfig.callbacks, this.callbacks, parsedConfig.tags, this.tags, parsedConfig.metadata, this.metadata, { verbose: this.verbose });

package/dist/schema/storage.d.ts

@@ -3,8 +3,28 @@ import { Serializable } from "../load/serializable.js";
  * Abstract interface for a key-value store.
  */
 export declare abstract class BaseStore<K, V> extends Serializable {
+    /**
+     * Abstract method to get multiple values for a set of keys.
+     * @param {K[]} keys - An array of keys.
+     * @returns {Promise<(V | undefined)[]>} - A Promise that resolves with array of values or undefined if key not found.
+     */
     abstract mget(keys: K[]): Promise<(V | undefined)[]>;
+    /**
+     * Abstract method to set a value for multiple keys.
+     * @param {[K, V][]} keyValuePairs - An array of key-value pairs.
+     * @returns {Promise<void>} - A Promise that resolves when the operation is complete.
+     */
     abstract mset(keyValuePairs: [K, V][]): Promise<void>;
+    /**
+     * Abstract method to delete multiple keys.
+     * @param {K[]} keys - An array of keys to delete.
+     * @returns {Promise<void>} - A Promise that resolves when the operation is complete.
+     */
     abstract mdelete(keys: K[]): Promise<void>;
+    /**
+     * Abstract method to yield keys optionally based on a prefix.
+     * @param {string} prefix - Optional prefix to filter keys.
+     * @returns {AsyncGenerator<K | string>} - An asynchronous generator that yields keys on iteration.
+     */
     abstract yieldKeys(prefix?: string): AsyncGenerator<K | string>;
 }

package/dist/storage/encoder_backed.cjs

@@ -2,6 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EncoderBackedStore = void 0;
 const storage_js_1 = require("../schema/storage.cjs");
+/**
+ * Class that provides a layer of abstraction over the base storage,
+ * allowing for the encoding and decoding of keys and values. It extends
+ * the BaseStore class.
+ */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 class EncoderBackedStore extends storage_js_1.BaseStore {
     constructor(fields) {
@@ -41,6 +46,12 @@ class EncoderBackedStore extends storage_js_1.BaseStore {
         this.valueSerializer = fields.valueSerializer;
         this.valueDeserializer = fields.valueDeserializer;
     }
+    /**
+     * Method to get multiple keys at once. It works with the encoded keys and
+     * serialized values.
+     * @param keys Array of keys to get
+     * @returns Promise that resolves with an array of values or undefined for each key
+     */
     async mget(keys) {
         const encodedKeys = keys.map(this.keyEncoder);
         const values = await this.store.mget(encodedKeys);
@@ -51,14 +62,30 @@ class EncoderBackedStore extends storage_js_1.BaseStore {
             return this.valueDeserializer(value);
         });
     }
+    /**
+     * Method to set multiple keys at once. It works with the encoded keys and
+     * serialized values.
+     * @param keyValuePairs Array of key-value pairs to set
+     * @returns Promise that resolves when the operation is complete
+     */
     async mset(keyValuePairs) {
         const encodedPairs = keyValuePairs.map(([key, value]) => [this.keyEncoder(key), this.valueSerializer(value)]);
         return this.store.mset(encodedPairs);
     }
+    /**
+     * Method to delete multiple keys at once. It works with the encoded keys.
+     * @param keys Array of keys to delete
+     * @returns Promise that resolves when the operation is complete
+     */
     async mdelete(keys) {
         const encodedKeys = keys.map(this.keyEncoder);
         return this.store.mdelete(encodedKeys);
     }
+    /**
+     * Method to yield keys. It works with the encoded keys.
+     * @param prefix Optional prefix to filter keys
+     * @returns AsyncGenerator that yields keys
+     */
     async *yieldKeys(prefix) {
         yield* this.store.yieldKeys(prefix);
     }

package/dist/storage/encoder_backed.d.ts

@@ -1,4 +1,9 @@
 import { BaseStore } from "../schema/storage.js";
+/**
+ * Class that provides a layer of abstraction over the base storage,
+ * allowing for the encoding and decoding of keys and values. It extends
+ * the BaseStore class.
+ */
 export declare class EncoderBackedStore<K, V, SerializedType = any> extends BaseStore<K, V> {
     lc_namespace: string[];
     store: BaseStore<string, SerializedType>;
@@ -11,8 +16,30 @@ export declare class EncoderBackedStore<K, V, SerializedType = any> extends Base
         valueSerializer: (value: V) => SerializedType;
         valueDeserializer: (value: SerializedType) => V;
     });
+    /**
+     * Method to get multiple keys at once. It works with the encoded keys and
+     * serialized values.
+     * @param keys Array of keys to get
+     * @returns Promise that resolves with an array of values or undefined for each key
+     */
     mget(keys: K[]): Promise<(V | undefined)[]>;
+    /**
+     * Method to set multiple keys at once. It works with the encoded keys and
+     * serialized values.
+     * @param keyValuePairs Array of key-value pairs to set
+     * @returns Promise that resolves when the operation is complete
+     */
     mset(keyValuePairs: [K, V][]): Promise<void>;
+    /**
+     * Method to delete multiple keys at once. It works with the encoded keys.
+     * @param keys Array of keys to delete
+     * @returns Promise that resolves when the operation is complete
+     */
     mdelete(keys: K[]): Promise<void>;
+    /**
+     * Method to yield keys. It works with the encoded keys.
+     * @param prefix Optional prefix to filter keys
+     * @returns AsyncGenerator that yields keys
+     */
     yieldKeys(prefix?: string | undefined): AsyncGenerator<string | K>;
 }

package/dist/storage/encoder_backed.js

@@ -1,4 +1,9 @@
 import { BaseStore } from "../schema/storage.js";
+/**
+ * Class that provides a layer of abstraction over the base storage,
+ * allowing for the encoding and decoding of keys and values. It extends
+ * the BaseStore class.
+ */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export class EncoderBackedStore extends BaseStore {
     constructor(fields) {
@@ -38,6 +43,12 @@ export class EncoderBackedStore extends BaseStore {
         this.valueSerializer = fields.valueSerializer;
         this.valueDeserializer = fields.valueDeserializer;
     }
+    /**
+     * Method to get multiple keys at once. It works with the encoded keys and
+     * serialized values.
+     * @param keys Array of keys to get
+     * @returns Promise that resolves with an array of values or undefined for each key
+     */
     async mget(keys) {
         const encodedKeys = keys.map(this.keyEncoder);
         const values = await this.store.mget(encodedKeys);
@@ -48,14 +59,30 @@ export class EncoderBackedStore extends BaseStore {
             return this.valueDeserializer(value);
         });
     }
+    /**
+     * Method to set multiple keys at once. It works with the encoded keys and
+     * serialized values.
+     * @param keyValuePairs Array of key-value pairs to set
+     * @returns Promise that resolves when the operation is complete
+     */
     async mset(keyValuePairs) {
         const encodedPairs = keyValuePairs.map(([key, value]) => [this.keyEncoder(key), this.valueSerializer(value)]);
         return this.store.mset(encodedPairs);
     }
+    /**
+     * Method to delete multiple keys at once. It works with the encoded keys.
+     * @param keys Array of keys to delete
+     * @returns Promise that resolves when the operation is complete
+     */
     async mdelete(keys) {
         const encodedKeys = keys.map(this.keyEncoder);
         return this.store.mdelete(encodedKeys);
     }
+    /**
+     * Method to yield keys. It works with the encoded keys.
+     * @param prefix Optional prefix to filter keys
+     * @returns AsyncGenerator that yields keys
+     */
     async *yieldKeys(prefix) {
         yield* this.store.yieldKeys(prefix);
     }

package/dist/storage/in_memory.cjs

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InMemoryStore = void 0;
 const storage_js_1 = require("../schema/storage.cjs");
+/**
+ * In-memory implementation of the BaseStore using a dictionary. Used for
+ * storing key-value pairs in memory.
+ */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 class InMemoryStore extends storage_js_1.BaseStore {
     constructor() {
@@ -19,19 +23,40 @@ class InMemoryStore extends storage_js_1.BaseStore {
             value: {}
         });
     }
+    /**
+     * Retrieves the values associated with the given keys from the store.
+     * @param keys Keys to retrieve values for.
+     * @returns Array of values associated with the given keys.
+     */
     async mget(keys) {
         return keys.map((key) => this.store[key]);
     }
+    /**
+     * Sets the values for the given keys in the store.
+     * @param keyValuePairs Array of key-value pairs to set in the store.
+     * @returns Promise that resolves when all key-value pairs have been set.
+     */
     async mset(keyValuePairs) {
         for (const [key, value] of keyValuePairs) {
             this.store[key] = value;
         }
     }
+    /**
+     * Deletes the given keys and their associated values from the store.
+     * @param keys Keys to delete from the store.
+     * @returns Promise that resolves when all keys have been deleted.
+     */
     async mdelete(keys) {
         for (const key of keys) {
             delete this.store[key];
         }
     }
+    /**
+     * Asynchronous generator that yields keys from the store. If a prefix is
+     * provided, it only yields keys that start with the prefix.
+     * @param prefix Optional prefix to filter keys.
+     * @returns AsyncGenerator that yields keys from the store.
+     */
     async *yieldKeys(prefix) {
         const keys = Object.keys(this.store);
         for (const key of keys) {

package/dist/storage/in_memory.d.ts

@@ -1,9 +1,34 @@
 import { BaseStore } from "../schema/storage.js";
+/**
+ * In-memory implementation of the BaseStore using a dictionary. Used for
+ * storing key-value pairs in memory.
+ */
 export declare class InMemoryStore<T = any> extends BaseStore<string, T> {
     lc_namespace: string[];
     protected store: Record<string, T>;
+    /**
+     * Retrieves the values associated with the given keys from the store.
+     * @param keys Keys to retrieve values for.
+     * @returns Array of values associated with the given keys.
+     */
     mget(keys: string[]): Promise<T[]>;
+    /**
+     * Sets the values for the given keys in the store.
+     * @param keyValuePairs Array of key-value pairs to set in the store.
+     * @returns Promise that resolves when all key-value pairs have been set.
+     */
     mset(keyValuePairs: [string, T][]): Promise<void>;
+    /**
+     * Deletes the given keys and their associated values from the store.
+     * @param keys Keys to delete from the store.
+     * @returns Promise that resolves when all keys have been deleted.
+     */
     mdelete(keys: string[]): Promise<void>;
+    /**
+     * Asynchronous generator that yields keys from the store. If a prefix is
+     * provided, it only yields keys that start with the prefix.
+     * @param prefix Optional prefix to filter keys.
+     * @returns AsyncGenerator that yields keys from the store.
+     */
     yieldKeys(prefix?: string | undefined): AsyncGenerator<string>;
 }

package/dist/storage/in_memory.js

@@ -1,4 +1,8 @@
 import { BaseStore } from "../schema/storage.js";
+/**
+ * In-memory implementation of the BaseStore using a dictionary. Used for
+ * storing key-value pairs in memory.
+ */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export class InMemoryStore extends BaseStore {
     constructor() {
@@ -16,19 +20,40 @@ export class InMemoryStore extends BaseStore {
             value: {}
         });
     }
+    /**
+     * Retrieves the values associated with the given keys from the store.
+     * @param keys Keys to retrieve values for.
+     * @returns Array of values associated with the given keys.
+     */
     async mget(keys) {
         return keys.map((key) => this.store[key]);
     }
+    /**
+     * Sets the values for the given keys in the store.
+     * @param keyValuePairs Array of key-value pairs to set in the store.
+     * @returns Promise that resolves when all key-value pairs have been set.
+     */
     async mset(keyValuePairs) {
         for (const [key, value] of keyValuePairs) {
             this.store[key] = value;
         }
     }
+    /**
+     * Deletes the given keys and their associated values from the store.
+     * @param keys Keys to delete from the store.
+     * @returns Promise that resolves when all keys have been deleted.
+     */
     async mdelete(keys) {
         for (const key of keys) {
             delete this.store[key];
         }
     }
+    /**
+     * Asynchronous generator that yields keys from the store. If a prefix is
+     * provided, it only yields keys that start with the prefix.
+     * @param prefix Optional prefix to filter keys.
+     * @returns AsyncGenerator that yields keys from the store.
+     */
     async *yieldKeys(prefix) {
         const keys = Object.keys(this.store);
         for (const key of keys) {

package/dist/storage/ioredis.cjs

@@ -2,6 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RedisByteStore = void 0;
 const storage_js_1 = require("../schema/storage.cjs");
+/**
+ * Class that extends the BaseStore class to interact with a Redis
+ * database. It provides methods for getting, setting, and deleting data,
+ * as well as yielding keys from the database.
+ */
 class RedisByteStore extends storage_js_1.BaseStore {
     constructor(fields) {
         super(fields);
@@ -55,6 +60,11 @@ class RedisByteStore extends storage_js_1.BaseStore {
         }
         return key;
     }
+    /**
+     * Gets multiple keys from the Redis database.
+     * @param keys Array of keys to be retrieved.
+     * @returns An array of retrieved values.
+     */
     async mget(keys) {
         const prefixedKeys = keys.map(this._getPrefixedKey.bind(this));
         const retrievedValues = await this.client.mgetBuffer(prefixedKeys);
@@ -67,6 +77,11 @@ class RedisByteStore extends storage_js_1.BaseStore {
             }
         });
     }
+    /**
+     * Sets multiple keys in the Redis database.
+     * @param keyValuePairs Array of key-value pairs to be set.
+     * @returns Promise that resolves when all keys have been set.
+     */
     async mset(keyValuePairs) {
         const decoder = new TextDecoder();
         const encodedKeyValuePairs = keyValuePairs.map(([key, value]) => [
@@ -84,9 +99,19 @@ class RedisByteStore extends storage_js_1.BaseStore {
         }
         await pipeline.exec();
     }
+    /**
+     * Deletes multiple keys from the Redis database.
+     * @param keys Array of keys to be deleted.
+     * @returns Promise that resolves when all keys have been deleted.
+     */
     async mdelete(keys) {
         await this.client.del(...keys.map(this._getPrefixedKey.bind(this)));
     }
+    /**
+     * Yields keys from the Redis database.
+     * @param prefix Optional prefix to filter the keys.
+     * @returns An AsyncGenerator that yields keys from the Redis database.
+     */
     async *yieldKeys(prefix) {
         let pattern;
         if (prefix) {

package/dist/storage/ioredis.d.ts

@@ -1,6 +1,11 @@
 /// <reference types="node" resolution-mode="require"/>
 import type { Redis } from "ioredis";
 import { BaseStore } from "../schema/storage.js";
+/**
+ * Class that extends the BaseStore class to interact with a Redis
+ * database. It provides methods for getting, setting, and deleting data,
+ * as well as yielding keys from the database.
+ */
 export declare class RedisByteStore extends BaseStore<string, Uint8Array> {
     lc_namespace: string[];
     protected client: Redis;
@@ -15,8 +20,28 @@ export declare class RedisByteStore extends BaseStore<string, Uint8Array> {
     });
     _getPrefixedKey(key: string): string;
     _getDeprefixedKey(key: string): string;
+    /**
+     * Gets multiple keys from the Redis database.
+     * @param keys Array of keys to be retrieved.
+     * @returns An array of retrieved values.
+     */
     mget(keys: string[]): Promise<(Buffer | undefined)[]>;
+    /**
+     * Sets multiple keys in the Redis database.
+     * @param keyValuePairs Array of key-value pairs to be set.
+     * @returns Promise that resolves when all keys have been set.
+     */
     mset(keyValuePairs: [string, Uint8Array][]): Promise<void>;
+    /**
+     * Deletes multiple keys from the Redis database.
+     * @param keys Array of keys to be deleted.
+     * @returns Promise that resolves when all keys have been deleted.
+     */
     mdelete(keys: string[]): Promise<void>;
+    /**
+     * Yields keys from the Redis database.
+     * @param prefix Optional prefix to filter the keys.
+     * @returns An AsyncGenerator that yields keys from the Redis database.
+     */
     yieldKeys(prefix?: string): AsyncGenerator<string>;
 }

package/dist/storage/ioredis.js

@@ -1,4 +1,9 @@
 import { BaseStore } from "../schema/storage.js";
+/**
+ * Class that extends the BaseStore class to interact with a Redis
+ * database. It provides methods for getting, setting, and deleting data,
+ * as well as yielding keys from the database.
+ */
 export class RedisByteStore extends BaseStore {
     constructor(fields) {
         super(fields);
@@ -52,6 +57,11 @@ export class RedisByteStore extends BaseStore {
         }
         return key;
     }
+    /**
+     * Gets multiple keys from the Redis database.
+     * @param keys Array of keys to be retrieved.
+     * @returns An array of retrieved values.
+     */
     async mget(keys) {
         const prefixedKeys = keys.map(this._getPrefixedKey.bind(this));
         const retrievedValues = await this.client.mgetBuffer(prefixedKeys);
@@ -64,6 +74,11 @@ export class RedisByteStore extends BaseStore {
             }
         });
     }
+    /**
+     * Sets multiple keys in the Redis database.
+     * @param keyValuePairs Array of key-value pairs to be set.
+     * @returns Promise that resolves when all keys have been set.
+     */
     async mset(keyValuePairs) {
         const decoder = new TextDecoder();
         const encodedKeyValuePairs = keyValuePairs.map(([key, value]) => [
@@ -81,9 +96,19 @@ export class RedisByteStore extends BaseStore {
         }
         await pipeline.exec();
     }
+    /**
+     * Deletes multiple keys from the Redis database.
+     * @param keys Array of keys to be deleted.
+     * @returns Promise that resolves when all keys have been deleted.
+     */
     async mdelete(keys) {
         await this.client.del(...keys.map(this._getPrefixedKey.bind(this)));
     }
+    /**
+     * Yields keys from the Redis database.
+     * @param prefix Optional prefix to filter the keys.
+     * @returns An AsyncGenerator that yields keys from the Redis database.
+     */
     async *yieldKeys(prefix) {
         let pattern;
         if (prefix) {