Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ivandotv committed Jan 4, 2022
1 parent c662421 commit 2bd3790
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 2 deletions.
5 changes: 5 additions & 0 deletions .changeset/shy-planets-drum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'graphql-no-alias': patch
---

Update docs
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ npm i graphql-no-alias
There are two ways to use this validation:

- Using the `directive` in the `schema`
- [Using the configuration options](#Imperative-configuration)
- [Using the configuration options](#Imperative-configuration)(better performance)

### Using the directive

Expand Down Expand Up @@ -192,6 +192,7 @@ const schema = buildSchema(`
### Imperative configuration

With imperative configuration, there is no need for type definition and schema modification.
This results in better performance since the `schema` is not analized (not looking for directives).

```ts
const permissions = {
Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export type Config = {
/**
* Creates validation
* @param config - {@link Config}
* @returns validation
* @returns validation function
*/
export default function createValidation(config?: Config): {
typeDefs: string
Expand Down

0 comments on commit 2bd3790

Please sign in to comment.