chore: tsdoc - getInstalledExecutors

bcnmy · Sep 19, 2024 · 5fb0f90 · 5fb0f90
1 parent f1e6985
commit 5fb0f90
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/src/sdk/clients/decorators/erc7579/getInstalledExecutors.ts b/src/sdk/clients/decorators/erc7579/getInstalledExecutors.ts
@@ -15,6 +15,22 @@ export type GetInstalledExecutorsParameters<
   cursor?: Hex
 }
 
+/**
+ * Retrieves the installed executors for a given smart account.
+ *
+ * @param client - The client instance.
+ * @param parameters - Parameters including the smart account, page size, and cursor.
+ * @returns A tuple containing an array of executor addresses and the next cursor.
+ * @throws {AccountNotFoundError} If the account is not found.
+ *
+ * @example
+ * import { getInstalledExecutors } from '@biconomy/sdk'
+ * 
+ * const [executors, nextCursor] = await getInstalledExecutors(nexusClient, {
+ *   pageSize: 10n
+ * })
+ * console.log(executors, nextCursor) // ['0x...', '0x...'], '0x...'
+ */
 export async function getInstalledExecutors<
   TSmartAccount extends SmartAccount | undefined
 >(