Skip to content

Commit

Permalink
update explanation of the constructor
Browse files Browse the repository at this point in the history
  • Loading branch information
haochizzle committed Oct 1, 2024
1 parent ffd746c commit d00712f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/docs/03-sdk/03-class-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ This section details the methods available to the `Sprinter` class in the Sprint

### `constructor(fetchOptions: Omit<FetchOptions, "signal">)`

Initializes the SDK with the given fetch options. The `signal` property is explicitly excluded from the fetch options because it is meant to be provided dynamically when individual requests are made, allowing developers to abort those requests if necessary.
Initializes the SDK with the given fetch options. The `signal` property is explicitly excluded, and only `baseURL` can be set.

#### Parameters

- `fetchOptions: Omit<FetchOptions, "signal">`: An object that allows specifying additional fetch options, excluding the `signal` property.
- `fetchOptions: Omit<FetchOptions, "signal">`: An object that allows specifying additional fetch options, excluding the `signal` property.

#### Example

Expand Down

0 comments on commit d00712f

Please sign in to comment.