Skip to content

Commit da86d3c

Browse files
authored
Usage instructions for v5 beta
Added example config for v5 beta.
1 parent ab9f3a5 commit da86d3c

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@ Install with:
1616
yarn add postgraphile postgraphile-plugin-connection-filter
1717
```
1818

19+
for PostGraphile v5 (beta):
20+
21+
```
22+
yarn add postgraphile@beta postgraphile-plugin-connection-filter@beta
23+
```
24+
1925
CLI usage via `--append-plugins`:
2026

2127
```
@@ -33,6 +39,20 @@ const middleware = postgraphile(DATABASE_URL, SCHEMAS, {
3339
});
3440
```
3541

42+
Config example for PostGraphile v5 (beta), `graphile.config.mjs`:
43+
44+
```ts
45+
import ConnectionFilterPlugin from 'postgraphile-plugin-connection-filter'
46+
47+
const preset = {
48+
extends: [
49+
ConnectionFilterPlugin.PostGraphileConnectionFilterPreset
50+
]
51+
}
52+
53+
export default preset
54+
```
55+
3656
## Performance and Security
3757

3858
By default, this plugin:

0 commit comments

Comments
 (0)