@sha1n/about-time 0.0.8 → 0.0.9

package/README.md

@@ -12,18 +12,19 @@ A collection of essential time related utilities.
 - [About-Time](#about-time)
 - [Install](#install)
 - [Utilities & Features](#utilities--features)
-  - [Delay](#delay)
-  - [WithTimeout](#withtimeout)
-  - [Sleep](#sleep)
-  - [Stopwatch](#stopwatch)
-  - [Until / Eventually](#until--eventually)
+  - [delay](#delay)
+  - [timeoutAround](#timeoutaround)
+  - [timeBounded](#timebounded)
+  - [sleep](#sleep)
+  - [stopwatch](#stopwatch)
+  - [until / eventually](#until--eventually)
   - [Retry](#retry)
     - [RetryPolicy](#retrypolicy)
       - [Simple retry policy](#simple-retry-policy)
       - [Fixed retry policy](#fixed-retry-policy)
       - [Exponential backoff retry policy](#exponential-backoff-retry-policy)
-    - [RetryAround](#retryaround)
-    - [Retriable](#retriable)
+    - [retryAround](#retryaround)
+    - [retriable](#retriable)
 
 
 # Install
@@ -32,7 +33,7 @@ npm i @sha1n/about-time
 ```
 
 # Utilities & Features
-## Delay
+## delay
 ```ts
 // Execute a function with delay and return it's value
 await delay(action, { time: 10 });
@@ -40,15 +41,23 @@ await delay(action, { time: 10, units: TimeUnit.Milliseconds });
 await delay(action, { time: 10, units: TimeUnit.Milliseconds, unref: true });
 ```
 
-## WithTimeout
+## timeoutAround
 ```ts
 // Execute a function and guards it with a specified timeout
-await withTimeout(action, { time: 10 });
-await withTimeout(action, { time: 10, units: TimeUnit.Milliseconds });
-await withTimeout(action, { time: 10, units: TimeUnit.Milliseconds, unref: true });
+await timeoutAround(action, { time: 10 });
+await timeoutAround(action, { time: 10, units: TimeUnit.Milliseconds });
+await timeoutAround(action, { time: 10, units: TimeUnit.Milliseconds, unref: true });
 ```
 
-## Sleep
+## timeBounded
+Wraps a given function with `timeoutAround` with the specified arguments.
+```ts
+const timeBoundAction = timeBounded(action, options);
+const result = await timeBoundAction();
+```
+
+
+## sleep
 ```ts
 // Pause execution for a specified amount of time
 await sleep(10);
@@ -56,7 +65,7 @@ await sleep(10, { units: TimeUnit.Seconds });
 await sleep(10, { units: TimeUnit.Seconds, unref: true });
 ```
 
-## Stopwatch
+## stopwatch
 ```ts
 // Measure time between actions
 const elapsed = stopwatch();
@@ -70,7 +79,7 @@ const elapsed1 = elapsed(TimeUnit.Milliseconds);
 const elapsed2 = elapsed(TimeUnit.Seconds);
 ```
 
-## Until / Eventually
+## until / eventually
 ```ts
 // Wait for a condition to become true
 await until(condition, { deadline: 10000 });
@@ -106,14 +115,14 @@ interval<sub>i</sub> = min(limit, (exponential<sup>i</sup> - 1) / 2)
 const retryPolicy = exponentialBackoffRetryPolicy(/* count = */10, /* opts?: { exponential?: number, limit?: number, units?: TimeUnit }*/);
 ```
 
-### RetryAround
+### retryAround
 Executes the given function with retries based on the specified policy and *optional* predicate.
 The predicate provides control over which errors we want to retry on.
 ```ts
 const result = await retryAround(action, retryPolicy, predicate);
 ```
 
-### Retriable
+### retriable
 Wraps a given function with `retryAround` with the specified arguments.
 ```ts
 const retriableAction = retriable(action, retryPolicy, predicate);

package/index.ts

@@ -1,5 +1,5 @@
 export { TimeUnit, toMilliseconds } from './lib/timeunit';
-export { withTimeout, sleep, delay, stopwatch, until, eventually } from './lib/utilities';
+export { timeoutAround, timeBounded, sleep, delay, stopwatch, until, eventually } from './lib/utilities';
 export {
   RetryPolicy,
   retryAround,

package/lib/utilities.ts

@@ -136,7 +136,7 @@ const eventually = until;
  * @param options timer options
  * @returns the action result
  */
-async function withTimeout<T>(action: () => T | Promise<T>, options: TimerOptions): Promise<T> {
+async function timeoutAround<T>(action: () => T | Promise<T>, options: TimerOptions): Promise<T> {
   const promisedAction = new Promise<T>((resolve, reject) => {
     try {
       resolve(action());
@@ -169,4 +169,10 @@ async function withTimeout<T>(action: () => T | Promise<T>, options: TimerOption
   return race;
 }
 
-export { withTimeout, sleep, delay, stopwatch, until, eventually };
+function timeBounded<T>(action: () => T | Promise<T>, options: TimerOptions): () => Promise<T> {
+  return () => {
+    return timeoutAround(action, options);
+  };
+}
+
+export { timeoutAround, timeBounded, sleep, delay, stopwatch, until, eventually };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sha1n/about-time",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "A set of essential time related utilities",
   "repository": "https://github.com/sha1n/about-time",
   "author": "Shai Nagar",
@@ -23,8 +23,9 @@
   "scripts": {
     "clean": "rm -rf ./dist",
     "build": "tsc",
-    "test": "DEBUG='error:*' jest --coverage && run lint",
     "lint": "eslint --fix --ext .js,.ts .",
+    "jest": "DEBUG='error:*' jest --coverage",
+    "test": "run jest && run lint",
     "prepublish": "run build"
   },
   "devDependencies": {