Skip to content

docs: fix subscribe callback type names #78

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
pozil merged 1 commit into from
Oct 8, 2025
Merged

docs: fix subscribe callback type names #78

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,7 +458,7 @@ When working with high volumes of events you can control the incoming flow of ev
This is the overall process:

1. Pass a number of requested events in your subscribe call.
1. Handle the `lastevent` [callback type](#subscribecallback) from subscribe callback to detect the end of the event batch.
1. Handle the `lastEvent` [callback type](#subscribecallback) from subscribe callback to detect the end of the event batch.
1. Subscribe to an additional batch of events with `client.requestAdditionalEvents(...)`. If you don't request additional events at this point, the gRPC subscription will close automatically (default Pub/Sub API behavior).

The code below illustrate how you can achieve event flow control:
Expand Down Expand Up @@ -713,9 +713,9 @@ Callback types:

| Name | Callback Data | Description |
| --------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `data` | Object | Client received a new event. The attached data is the parsed event data. |
| `event` | Object | Client received a new event. The attached data is the parsed event data. |
| `error` | [EventParseError](#eventparseerror) or Object | Signals an event parsing error or a gRPC stream error. |
| `lastevent` | void | Signals that we received the last event that the client requested. The stream will end shortly. |
| `lastEvent` | void | Signals that we received the last event that the client requested. The stream will end shortly. |
| `end` | void | Signals the end of the gRPC stream. |
| `grpcKeepalive` | `{ latestReplayId: number, pendingNumRequested: number }` | Server publishes this gRPC keep alive message every 270 seconds (or less) if there are no events. |
| `grpcStatus` | Object | Misc gRPC stream status information. |
Expand Down
Loading