EB-3 Making first argument just the function to backoff (#6)

Author: samisayegh

README.md

@@ -1,4 +1,5 @@
 # exponential-backoff
+
 A utility that allows retrying a function with an exponential delay between attempts.
 
 ## Installation
@@ -8,52 +9,51 @@ npm i exponential-backoff
 ```
 
 ## Usage
-The generic `backOff<T>` function takes an `IBackOffRequest<T>` object, and an optional `IBackOffOptions` object. It returns a generic `Promise<T>`.
+
+The generic `backOff<T>` function takes a function `() => Promise<T>` to be retried, and an optional `IBackOffOptions` object. It returns a generic `Promise<T>`.
 
 ```
-function backOff<T>(request: IBackOffRequest<T>, options: Partial<IBackOffOptions> = {}): Promise<T>
+function backOff<T>(request: () => Promise<T>, options: IBackOffOptions = {}): Promise<T>
 ```
 
-### `IBackOffRequest<T>`
-* `fn: () => Promise<T>`
+Migrating from v1 to v2? Here are our [breaking changes](https://github.com/coveo/exponential-backoff/tree/master/doc/v1-to-v2-migration.md).
 
-    The function to be attempted.
+### `IBackOffOptions`
 
-* `retry?: (e, attemptNumber: number) => boolean`
-    
-    Everytime `fn` returns a rejected promise, the `retry` function is called with the error and the attempt number. Returning `true` will reattempt the function as long as the `numOfAttempts` has not been exceeded. Returning `false` will end the execution.
-    
-    Default value is a function that always returns `true`.
+- `delayFirstAttempt?: boolean`
 
-### `IBackOffOptions`
-* `delayFirstAttempt?: boolean`
+  Decides whether the `startingDelay` should be applied before the first call. If `false`, the first call will occur without a delay.
+
+  Default value is `false`.
+
+- `jitter?: JitterType | string`
+
+  Decides whether a [jitter](https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/) should be applied to the delay. Possible values are `full` and `none`.
+
+  Default value is `none`.
+
+- `numOfAttempts?: number`
+
+  The maximum number of times to attempt the function.
 
-    Decides whether the `startingDelay` should be applied before the first call to `fn`. If `false`, the first call to `fn` will occur without a delay.
+  Default value is `10`.
 
-    Default value is `true`.
+  Minimum value is `1`.
 
-* `jitter?: JitterType | string`
+- `retry?: (e: any, attemptNumber: number) => boolean`
 
-    Decides whether a [jitter](https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/) should be applied to the delay. Possible values are `full` and `none`.
+  Everytime the function returns a rejected promise, the `retry` function is called with the error and the attempt number. Returning `true` will reattempt the function as long as the `numOfAttempts` has not been exceeded. Returning `false` will end the execution.
 
-    Default value is `none`.
+  Default value is a function that always returns `true`.
 
-* `numOfAttempts?: number`
+- `startingDelay?: number`
 
-    The maximum number of times to attempt the function.
-    
-    Default value is `10`.
-    
-    Minimum value is `1`.
+  The delay before executing the function for the first time.
 
-* `startingDelay?: number`
+  Default value is `100` ms.
 
-    The delay before executing the function for the first time.
-    
-    Default value is `100` ms.
+- `timeMultiple?: number`
 
-* `timeMultiple?: number`
+  The `startingDelay` is multiplied by the `timeMultiple` to increase the delay between reattempts.
 
-    The `startingDelay` is multiplied by the `timeMultiple` value to increase the delay between reattempts.
-    
-    Default value is `2`.
+  Default value is `2`.

doc/v1-to-v2-migration.md

@@ -0,0 +1,9 @@
+## Migrating from v1 to v2
+
+If you are migrating from v1 to v2, be aware of the following breaking changes:
+
+- The first argument of `backOff<T>` is now just the function you want to backoff. The `retry` function is still available as a property of `IBackOffOptions`.
+
+- The default value for the `delayFirstAttempt` option is now `false`.
+
+That's all folks!