All prop tests use getCanisterActor

test/get_canister_actor.ts

@@ -5,12 +5,26 @@ import { join } from 'path';
 
 import { getCanisterId } from '../dfx';
 
+/**
+ * Options for getting a canister actor
+ * @interface GetCanisterActorOptions
+ * @property {Identity} [identity] - Optional identity for authentication
+ * @property {Agent} [agent] - Optional pre-configured agent
+ * @property {string} [parentDir] - Optional parent directory path for the dfx generated files
+ */
 type GetCanisterActorOptions = {
     identity?: Identity;
     agent?: Agent;
     parentDir?: string;
 };
 
+/**
+ * Creates an actor instance for interacting with a canister
+ * @template T - The interface type of the actor
+ * @param {string} canisterName - Name of the canister to create an actor for
+ * @param {GetCanisterActorOptions} [options={}] - Configuration options
+ * @returns {Promise<ActorSubclass<T>>} A promise that resolves to the actor instance
+ */
 export async function getCanisterActor<T>(
     canisterName: string,
     options: GetCanisterActorOptions = {}

test/property/get_actor.ts

@@ -1,8 +1,17 @@
-import { Agent } from '@dfinity/agent';
+import { ActorSubclass, Agent } from '@dfinity/agent';
 
 import { getCanisterActor } from '../get_canister_actor';
 
-export async function getActor(parentDir: string, agent?: Agent): Promise<any> {
+/**
+ * Creates an actor instance with cache clearing functionality
+ * @param {string} parentDir - Parent directory path containing the dfx generated files
+ * @param {Agent} [agent] - Optional pre-configured agent
+ * @returns {Promise<ActorSubclass<T>>} A promise that resolves to the actor instance
+ */
+export async function getActor<T>(
+    parentDir: string,
+    agent?: Agent
+): Promise<ActorSubclass<T>> {
     const resolvedPathIndex = require.resolve(
         `${parentDir}/dfx_generated/canister/index.js`
     );