diff --git a/README.md b/README.md index 10c7568..457932c 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,12 @@ npm i exponential-backoff ## Usage -The `backOff` function takes a promise-returning function to retry, and an optional `BackOffOptions` object. It returns a `Promise`. +The `backOff` function takes a promise-returning function to retry, and an optional `BackoffOptions` object. It returns a `Promise`. ```ts function backOff( request: () => Promise, - options?: BackOffOptions + options?: BackoffOptions ): Promise; ``` @@ -42,7 +42,7 @@ main(); Migrating across major versions? Here are our [breaking changes](https://github.com/coveo/exponential-backoff/tree/master/doc/migration-guide.md). -### `BackOffOptions` +### `BackoffOptions` - `delayFirstAttempt?: boolean`