use tsdoc comments for hover/completion hints

src/retry-promise.ts

@@ -3,28 +3,51 @@
 import {timeout} from "./timeout";
 
 export interface RetryConfig<T = any> {
-    // number of maximal retry attempts (default: 10)
+    /**
+     * number of maximal retry attempts
+     * @defaultValue 10
+     */
     retries: number | "INFINITELY";
 
-    // wait time between retries in ms (default: 100)
+    /**
+     * wait time between retries in ms
+     * @defaultValue 100
+     */
     delay: number;
 
-    // check the result, will retry until true (default: () => true)
+    /**
+     * check the result, will retry until true
+     * @defaultValue () => true
+     */
     until: (t: T) => boolean;
 
-    // log events (default: () => undefined)
+    /**
+     * log events
+     * @defaultValue () => undefined
+     */
     logger: (msg: string) => void;
 
-    // overall timeout in ms (default: 60 * 1000)
+    /**
+     * overall timeout in ms
+     * @defaultValue 60 * 1000
+     */
     timeout: number | "INFINITELY";
 
-    // increase delay with every retry (default: "FIXED")
+    /**
+     * increase delay with every retry
+     * @defaultValue "FIXED"
+     */
     backoff: "FIXED" | "EXPONENTIAL" | "LINEAR" | ((attempt: number, delay: number) => number);
 
-    // maximal backoff in ms (default: 5 * 60 * 1000)
+    /**
+     * maximal backoff in ms
+     * @defaultValue 5 * 60 * 1000
+     */
     maxBackOff: number;
 
-    // allows to abort retrying for certain errors
+    /**
+     * allows to abort retrying for certain errors
+     */
     retryIf: (error: any) => boolean
 }