Skip to content

Commit

Permalink
docs: mark optimize option as @experimental
Browse files Browse the repository at this point in the history
  • Loading branch information
angeloashmore committed May 3, 2023
1 parent 59f84ed commit 343534f
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion src/createClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,9 @@ type FetchParams = {
type OptimizeParams = {
/**
* Options that determine if or how the client is optimized.
*
* @experimental These options may change in the future. Please treat
* `optimize` as an undocumented feature.
*/
optimize?: {
/**
Expand All @@ -302,7 +305,9 @@ type OptimizeParams = {
repositoryRequests?: boolean;

/**
* Determines if concurrent requests to the same URL should be optimized. The optimizations result in less network requests and quicker responses.
* Determines if concurrent requests to the same URL should be
* optimized. The optimizations result in less network requests and quicker
* responses.
*
* Only opt out of this optimization if you know what you are doing.
*
Expand Down

0 comments on commit 343534f

Please sign in to comment.