graphile / graphile/graphile.github.io

Documentation Improvement by adding an example and description for initialEvent for custom subscriptions

Open
#401 1 comment 1 reaction 0 assignees View on GitHub
help wanted quick
Dominant language
SCSS
Stars
27
Forks
126
PR merge metrics
No merged PRs in 30d

Description

Over the last few days I've been trying to create a custom subscription that sends the data directly after connecting. However, there is no example in the documentation of an initial event or any evidence that there is an interface for it. The default behavior of an custom subscription is that it only fetches the previous data and the new data (on insert) after an event was been triggered on the database side.

I only got the information about the `initialEvent` from the discord server:
- By providing the `initialEvent` argument to `@pgSubscription(...)` in `typeDefs` you can pass to it the function which you want to be executed on connection establishment the same way as `currentUserTopicFromContext` from the docs to topic:
```js
currentUserUpdated: UserSubscriptionPayload @pgSubscription(topic: ${embed(
currentUserTopicFromContext,
)})
```
with `initialEvent`:
```js
currentUserUpdated: UserSubscriptionPayload @pgSubscription(topic: ${embed(
currentUserTopicFromContext,
)}, initialEvent: ${embed(
onInitialEvent, //the function that you want to be executed
)})
```

The function that you want to be executed in `initialEvent` has the same structure as `currentUserTopicFromContext`:
```js
const onInitialEvent = async (_args, context, _resolveInfo) => {
// do something
return {}; // return an object
}
```

Now because returning an empty object was the solution for my problem (get already existing data on connection establishment), I didn't dig any deeper on what arguments I can give to the object to control the behavior and what operations can be done in the `initialEvent` function. This can be added additionally to the documentation.

Adding description for `initialEvent` and examples for it to the documentation to make it clear that something like that exists would help allot.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.