Use TSDoc notation

For improved IDE integration on hover
fireblocks · Jan 19, 2023 · cbb0927 · cbb0927
1 parent 82bdd16
commit cbb0927
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -41,9 +41,16 @@ const fireblocks = new FireblocksSDK(privateKey, apiKey, baseUrl, authProvider,
 The `options` argument has the following structure:
 ```typescript
 interface SDKOptions {
-    timeoutInMs?: number;               // HTTP request timeout
-    proxy?: AxiosProxyConfig | false;   // Proxy configuration
-    anonymousPlatform?: boolean;        // Whether to remove platform from User-Agent header
-    userAgent?: string;                 // Additional product identifier to be prepended to the User-Agent header
+    /** HTTP request timeout */
+    timeoutInMs?: number;
+
+    /** Proxy configurations */
+    proxy?: AxiosProxyConfig | false;
+
+    /** Whether to remove platform from User-Agent header */
+    anonymousPlatform?: boolean;
+
+    /** Additional product identifier to be prepended to the User-Agent header */
+    userAgent?: string;
 }
 ```
diff --git a/src/fireblocks-sdk.ts b/src/fireblocks-sdk.ts
@@ -73,10 +73,17 @@ import { AxiosProxyConfig } from "axios";
 export * from "./types";
 
 export interface SDKOptions {
-    timeoutInMs?: number;               // HTTP request timeout
-    proxy?: AxiosProxyConfig | false;   // Proxy configuration
-    anonymousPlatform?: boolean;        // Whether to remove platform from User-Agent header
-    userAgent?: string;                 // Additional product identifier to be prepended to the User-Agent header
+    /** HTTP request timeout */
+    timeoutInMs?: number;
+
+    /** Proxy configurations */
+    proxy?: AxiosProxyConfig | false;
+
+    /** Whether to remove platform from User-Agent header */
+    anonymousPlatform?: boolean;
+
+    /** Additional product identifier to be prepended to the User-Agent header */
+    userAgent?: string;
 }
 
 export class FireblocksSDK {