Skip to content

Commit

Permalink
Added how to use section
Browse files Browse the repository at this point in the history
  • Loading branch information
peldax authored Jul 1, 2021
1 parent dac7cf0 commit c3d0e01
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,30 @@ Install package using composer

## How to use

This package includes two modules. They can be used together or each on their own.
- `MaxDepthModule` validates maximum depth of a query.
- `MaxNodesModule` validates that size of a query does not exceed maximum number of nodes.
- One node is essentially a single value which is to be resolved.
- This module automatically recognises "multiplier" arguments, such as `limit`, which multiply inner number of nodes for that field.
- Default multiplier arguments are `['limit', 'first', 'last']`, but can be changed using second constructor argument.
- If you wish to disable this feature, set the constructor argument to empty array.

1. Register selected modules to GraPHPinator:

```php
$depthModule = new \Graphpinator\QueryCost\MaxDepthModule(
10, // selected maximum depth
);
$nodesModule = new \Graphpinator\QueryCost\MaxNodesModule(
10000, // selected number of nodes
['limit'], // optional: multiplier argument names
);
$graphpinator = new \Graphpinator\Graphpinator(
$schema,
$catchExceptions,
new \Graphpinator\Module\ModuleSet([$depthModule, $nodesModule /* possibly other modules */]),
$logger,
);
```

2. You are all set, queries are validated for maximum depth/maximum number of nodes.

0 comments on commit c3d0e01

Please sign in to comment.