@openmrs/esm-utils 4.0.0-pre.0 → 4.0.0-pre.1

package/dist/retry.d.ts

@@ -0,0 +1,38 @@
+/** @module @category Utility */
+/**
+ * Options for configuring the behavior of the {@link retry} function.
+ */
+export interface RetryOptions {
+    /**
+     * Determines whether the retry function should retry executing the function after it failed
+     * with an error on the current attempt.
+     * @param attempt The current (zero-based) retry attempt. `0` indicates the initial attempt.
+     */
+    shouldRetry?(attempt: number): any;
+    /**
+     * Calculates the next delay (in milliseconds) before a retry attempt.
+     * Returning a value for the inital attempt (`0`) delays the initial function invocation.
+     * @param attempt The current (zero-based) retry attempt. `0` indicates the initial attempt.
+     */
+    getDelay?(attempt: number): number;
+    /**
+     * Called when invoking the function resulted in an error.
+     * Allows running side-effects on errors, e.g. logging.
+     * @param e The error thrown by the function.
+     * @param attempt The current (zero-based) retry attempt. `0` indicates the initial attempt.
+     */
+    onError?(e: any, attempt: number): void;
+}
+/**
+ * Executes the specified function and retries executing on failure with a custom backoff strategy
+ * defined by the options.
+ *
+ * If not configured otherwise, this function uses the following default options:
+ * * Retries 5 times beyond the initial attempt.
+ * * Uses an exponential backoff starting with an initial delay of 1000ms.
+ * @param fn The function to be executed and retried on failure.
+ * @param options Additional options which configure the retry behavior.
+ * @returns The result of successfully executing `fn`.
+ * @throws Rethrows the final error of running `fn` when the function stops retrying.
+ */
+export declare function retry<T>(fn: () => Promise<T>, options?: RetryOptions): Promise<T>;

package/dist/translate.d.ts

@@ -0,0 +1 @@
+export declare function translateFrom(moduleName: string, key: string, fallback?: string, options?: object): string;

package/dist/version.d.ts

@@ -0,0 +1 @@
+export declare function isVersionSatisfied(requiredVersion: string, installedVersion: string): boolean;

package/dist/version.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-utils",
-  "version": "4.0.0-pre.0",
+  "version": "4.0.0-pre.1",
   "license": "MPL-2.0",
   "description": "Helper utilities for OpenMRS",
   "browser": "dist/openmrs-esm-utils.js",
@@ -49,5 +49,5 @@
   "dependencies": {
     "semver": "^7.3.2"
   },
-  "gitHead": "254a7226212aac82df4434639b2584e24ac240e4"
+  "gitHead": "9f58b801f07526083a9edc1cc5a1e58660d71eb0"
 }

package/src/omrs-dates.ts

@@ -178,6 +178,8 @@ const defaultOptions: FormatDateOptions = {
  * When time is included, it is appended with a comma and a space. This
  * agrees with the output of `Date.prototype.toLocaleString` for *most*
  * locales.
+ *
+ * TODO: Shouldn't throw on null input
  */
 export function formatDate(date: Date, options?: Partial<FormatDateOptions>) {
   const { mode, time, day, year }: FormatDateOptions = {