From b027ea9dc42fa5e05616bfd971dca289e9382324 Mon Sep 17 00:00:00 2001
From: jin <32600939+madjin@users.noreply.github.com>
Date: Sat, 28 Dec 2024 18:40:32 -0500
Subject: [PATCH 1/4] docs: Add JSDoc documentation to constants.ts


From e7c6a61b09ffc08922b6ef1ab414fe800ebc6ed0 Mon Sep 17 00:00:00 2001
From: jin <32600939+madjin@users.noreply.github.com>
Date: Sat, 28 Dec 2024 18:40:32 -0500
Subject: [PATCH 2/4] docs: Add JSDoc documentation to createRuntime.ts

---
 packages/core/src/test_resources/createRuntime.ts | 11 +++++++++++
 1 file changed, 11 insertions(+)

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<string, string> | 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,

From a69aac609b8f5c5cf9b009035d893b99915f63d6 Mon Sep 17 00:00:00 2001
From: jin <32600939+madjin@users.noreply.github.com>
Date: Sat, 28 Dec 2024 18:40:33 -0500
Subject: [PATCH 3/4] docs: Add JSDoc documentation to testSetup.ts


From 15a30970a4c105bea9b9d346b20ed6a255be22f7 Mon Sep 17 00:00:00 2001
From: jin <32600939+madjin@users.noreply.github.com>
Date: Sat, 28 Dec 2024 18:40:33 -0500
Subject: [PATCH 4/4] docs: Add JSDoc documentation to types.ts

---
 packages/core/src/test_resources/types.ts | 8 ++++++++
 1 file changed, 8 insertions(+)

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;