Skip to content

Commit

Permalink
docs(harden-plugin): Add note on penalty when omitting take option
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelbromley committed Jun 29, 2023
1 parent 555666c commit 7a147a8
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions packages/harden-plugin/src/harden.plugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,10 @@ import { HardenPluginOptions } from './types';
* The complexity score is calculated by the [graphql-query-complexity library](https://www.npmjs.com/package/graphql-query-complexity),
* and by default uses the {@link defaultVendureComplexityEstimator}, which is tuned specifically to the Vendure Shop API.
*
* {{% alert "warning" %}}
* Note: By default, if the "take" argument is omitted from a list query (e.g. the `products` or `collections` query), a default factor of 1000 is applied.
* {{% /alert %}}
*
* The optimal max complexity score will vary depending on:
*
* - The requirements of your storefront and other clients using the Shop API
Expand Down

0 comments on commit 7a147a8

Please sign in to comment.