Skip to content
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.

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

Update docs and change/tidy some related APIs #229

Merged
merged 40 commits into from
Mar 14, 2023
Merged

Update docs and change/tidy some related APIs #229

merged 40 commits into from
Mar 14, 2023

Conversation

benjie
Copy link
Member

@benjie benjie commented Mar 13, 2023

  • 🚨 hookArgs has swapped the order of the second and third arguments, so that it matches grafast. It's now hookArgs(args, resolvedPreset, ctx). Please search your code for hookArgs and update it.
  • 🚨 preset.server.eventStreamRoute is now preset.server.eventStreamPath to match the graphqlPath and graphiqlPath options. This does not affect makeV4Preset({ eventStreamRoute: ... }).
  • 🚨 PgRBACPlugin is now included by default, you can disable it via disablePlugins: ['PgRBACPlugin']. Users of makeV4Preset() are unaffected.
  • 🚨 pgConfig.pubsub now defaults to true (we support LISTEN/NOTIFY by default unless you turn it off)
  • 🚨 listenWithPgClientFromPgConfig is no more; please use pgConfig.pgSubscriber instead
  • 🚨 pgl.getServerParams() is now pgl.getSchemaResult()
  • Watch mode now works in Ruru, and without the hacks V4 used! My GraphiQL PR that means that schema replacement should not break the navigation stack was merged; I've updated Ruru to include this fix
  • makeV4Preset() now supports eventStreamRoute option
  • 💅 grafastSync() now supports the same options as grafast()
  • 💅 pgConfig.listen removed, it was redundant versus pgConfig.pgSubscriber
  • 💅 Removed preset.schema.subscriptions option which didn't do anything
  • 💅 graphile config print now omits undefined values
  • 📖 Significant documentation updates

…ents in the same order as `grafast()`: `hookArgs(args, resolvedPreset, ctx)`. Please update all your `hookArgs` calls.
…PgSubscriber. Have migrated PgIntrospectionPlugin to use PgSubscriber instead.
…onsistency with 'graphqlPath' and 'graphiqlPath'. V4 preset unaffected.
@benjie benjie merged commit 3790630 into planning Mar 14, 2023
@benjie benjie deleted the update-docs branch March 14, 2023 09:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant