Skip to content

Commit

Permalink
Usage instructions for v5 beta
Browse files Browse the repository at this point in the history
Added example config for v5 beta.
  • Loading branch information
speier authored Apr 22, 2024
1 parent ab9f3a5 commit da86d3c
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ Install with:
yarn add postgraphile postgraphile-plugin-connection-filter
```

for PostGraphile v5 (beta):

```
yarn add postgraphile@beta postgraphile-plugin-connection-filter@beta
```

CLI usage via `--append-plugins`:

```
Expand All @@ -33,6 +39,20 @@ const middleware = postgraphile(DATABASE_URL, SCHEMAS, {
});
```

Config example for PostGraphile v5 (beta), `graphile.config.mjs`:

```ts
import ConnectionFilterPlugin from 'postgraphile-plugin-connection-filter'

const preset = {
extends: [
ConnectionFilterPlugin.PostGraphileConnectionFilterPreset
]
}

export default preset
```

## Performance and Security

By default, this plugin:
Expand Down

0 comments on commit da86d3c

Please sign in to comment.