Skip to content

Commit

Permalink
maint - readme update (#136)
Browse files Browse the repository at this point in the history
  • Loading branch information
erdirowlands authored Sep 3, 2024
1 parent 8ea98bb commit 6b8ded4
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -336,11 +336,13 @@ The `authRequestReadTimeout` option allows you to specify a timeout in milliseco

If the request is aborted due to this timeout the SDK will fail to initialize and an `ERROR_AUTH` and `ERROR` event will be emitted.

The default value if not specified is `0` which means that no timeout will occur.

**This only applies to the authentiaction request. If you wish to set a read timeout on the remaining requests made by the SDK, you may register [API Middleware](#api-middleware)

```typescript
const options = {
authRequestReadTimeout: 30000, // Timeout in milliseconds (default: 30000)
authRequestReadTimeout: 30000, // Timeout in milliseconds (default: 0 - no timeout)
};

const client = initialize(
Expand Down

0 comments on commit 6b8ded4

Please sign in to comment.