add jsdoc for added skipReceiveAddress property

TICKET: WP-1271
BitGo · Jan 16, 2025 · 9cf92e2 · 9cf92e2
1 parent f7eaefe
commit 9cf92e2
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/modules/sdk-core/src/bitgo/wallet/iWallets.ts b/modules/sdk-core/src/bitgo/wallet/iWallets.ts
@@ -166,6 +166,10 @@ export interface ListWalletOptions extends PaginationOptions {
   skip?: number;
   getbalances?: boolean;
   allTokens?: boolean;
+  /**
+   * Optional property for receiving an address.
+   * If skipReceiveAddress is set to true, the receiveAddress property will not be returned in the wallet object.
+   */
   skipReceiveAddress?: boolean;
 }