Skip to content

Usage instructions for v5 beta #210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
benjie merged 3 commits into from
Feb 11, 2025
Merged

Usage instructions for v5 beta #210

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
da86d3c
Usage instructions for v5 beta
speier Apr 22, 2024
1ed2866
Stick it through prettier playground
benjie Feb 11, 2025
b07511d
Merge branch 'v5' into patch-1
benjie Feb 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
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
Loading