🤖 Merge PR DefinitelyTyped#74573 add throttle and retry types for hafas-client by @tsanona

Author: tsanona

types/hafas-client/retry.d.ts

@@ -0,0 +1,31 @@
+import { Profile } from ".";
+
+/**
+ * Retry options.
+ *
+ * Further opts could be used. Check {@link https://github.com/sindresorhus/p-retry | p-retry} for more info.
+ */
+export interface RetryOpts {
+    /**
+     * The maximum amount of times to retry the operation.
+     * @default 3
+     */
+    retries?: number;
+    /**
+     * The exponential factor to use.
+     * @default 3
+     */
+    factor?: number;
+    /**
+     * The number of milliseconds before starting the first retry.
+     * @default 5000
+     */
+    minTimeout?: number;
+}
+
+/**
+ * Use {@link Profile} opt-in for retrying failed requests to the endpoint.
+ * @param profile - The base {@link Profile}
+ * @param retryOpts - The {@link RetryOpts}
+ */
+export function withRetrying(profile: Profile, retryOpts?: RetryOpts): Profile;

types/hafas-client/throttle.d.ts

@@ -0,0 +1,9 @@
+import { Profile } from ".";
+
+/**
+ * Use {@link Profile} opt-in for throttling requests to the endpoint.
+ * @param profile - The base {@link Profile}
+ * @param [limit=5] - The maximum number of calls within an {@link interval}.
+ * @param [interval=1000] - The timespan for {@link limit} in milliseconds.
+ */
+export function withThrottling(profile: Profile, limit?: number, interval?: number): Profile;

types/hafas-client/tsconfig.json

@@ -15,6 +15,8 @@
     },
     "files": [
         "index.d.ts",
+        "throttle.d.ts",
+        "retry.d.ts",
         "hafas-client-tests.ts"
     ]
 }