diff --git a/packages/core/src/test_resources/createRuntime.ts b/packages/core/src/test_resources/createRuntime.ts index e4a6f0016b2..46e9163c0cc 100644 --- a/packages/core/src/test_resources/createRuntime.ts +++ b/packages/core/src/test_resources/createRuntime.ts @@ -17,6 +17,17 @@ import { } from "./constants.ts"; import { User } from "./types.ts"; +/** + * Create a runtime environment with the specified configurations. + * + * @param {Object} options - The options for creating the runtime environment. + * @param {Record | NodeJS.ProcessEnv} [options.env] - The environment variables. + * @param {number} [options.conversationLength] - The length of the conversation. + * @param {Evaluator[]} [options.evaluators] - The array of evaluators. + * @param {Action[]} [options.actions] - The array of actions. + * @param {Provider[]} [options.providers] - The array of providers. + * @returns {Object} - An object containing the created user, session, and runtime. + */ export async function createRuntime({ env, conversationLength, diff --git a/packages/core/src/test_resources/types.ts b/packages/core/src/test_resources/types.ts index 634e266cbe4..57242e76f4b 100644 --- a/packages/core/src/test_resources/types.ts +++ b/packages/core/src/test_resources/types.ts @@ -1,3 +1,11 @@ +/** + * Interface representing a user. + * @typedef {Object} User + * @property {string} id - The unique identifier for the user. + * @property {string} [email] - The email address of the user (optional). + * @property {string} [phone] - The phone number of the user (optional). + * @property {string} [role] - The role of the user (optional). + */ export interface User { id: string; email?: string;