Merge pull request #1549 from elizaOS/docs-update-full-1735429229223

docs: Add JSDoc documentation

Author: monilpat

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,

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;