chore: tsdoc - bicoBundlerClient

bcnmy · Sep 19, 2024 · 427ce0e · 427ce0e
1 parent fc3957e
commit 427ce0e
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/src/sdk/clients/createBicoBundlerClient.ts b/src/sdk/clients/createBicoBundlerClient.ts
@@ -18,6 +18,18 @@ type BicoBundlerClientConfig = Omit<BundlerClientConfig, "transport"> &
       }
   >
 
+/**
+ * Creates a Bico Bundler Client with a given Transport configured for a Chain.
+ *
+ * @param parameters - Configuration for the Bico Bundler Client
+ * @returns A Bico Bundler Client
+ *
+ * @example
+ * import { createBicoBundlerClient, http } from '@biconomy/sdk'
+ * import { mainnet } from 'viem/chains'
+ *
+ * const bundlerClient = createBicoBundlerClient({ chain: mainnet });
+ */
 export const createBicoBundlerClient = (
   parameters: BicoBundlerClientConfig
 ): BundlerClient => {