Release v3.0.0 (#21)

coveooss · Apr 7, 2020 · 0435a2f · 0435a2f
1 parent 16f3f46
commit 0435a2f
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -40,7 +40,7 @@ async function main() {
 main();
 ```
 
-Migrating from v1 to v2? Here are our [breaking changes](https://github.com/coveo/exponential-backoff/tree/master/doc/v1-to-v2-migration.md).
+Migrating across major versions? Here are our [breaking changes](https://github.com/coveo/exponential-backoff/tree/master/doc/migration-guide.md).
 
 ### `IBackOffOptions`
 

diff --git a/doc/v1-to-v2-migration.md → doc/migration-guide.md b/doc/v1-to-v2-migration.md → doc/migration-guide.md
@@ -1,9 +1,13 @@
-## Migrating from v1 to v2
+If you are migrating across a major version, be aware of the following breaking changes:
 
-If you are migrating from v1 to v2, be aware of the following breaking changes:
+## Migrating from v1 to v2
 
 - 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`.
 
+## Migrating from v2 to v3
+
+- The `jitter` option now uses a union string type for easier configurability. The `JitterTypes` enum is no longer available.
+
 That's all folks!
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "exponential-backoff",
-  "version": "2.2.1",
+  "version": "3.0.0",
   "description": "A utility that allows retrying a function with an exponential delay between attempts.",
   "main": "dist/backoff.js",
   "types": "dist/backoff.d.ts",