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.

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

Fix FCL EventFilter documentation #1180

Merged
merged 2 commits into from
Mar 18, 2025
Merged

Fix FCL EventFilter documentation #1180

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7685d8
Fix EventFilter documentation
jribbink Mar 18, 2025
cba8bce
reuse
jribbink Mar 18, 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
31 changes: 19 additions & 12 deletions docs/tools/clients/fcl-js/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1200,15 +1200,9 @@ A build that returns a [event stream connection](#eventstream) once decoded. It

#### Arguments

| Name | Type | Description |
| ------------------------ | ------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `opts` | `Object` | An object with the following keys: |
| `opts.startBlockId` | string | undefined | The block ID to start listening for events. Example: `9dda5f281897389b99f103a1c6b180eec9dac870de846449a302103ce38453f3` |
| `opts.startHeight` | number | undefined | The block height to start listening for events. Example: `123` |
| `opts.eventTypes` | string[] | undefined | The event types to listen for. Example: `A.7e60df042a9c0868.FlowToken.TokensWithdrawn` |
| `opts.addresses` | string[] | undefined | The addresses to listen for. Example: `0x7e60df042a9c0868` |
| `opts.contracts` | string[] | undefined | The contracts to listen for. Example: `0x7e60df042a9c0868` |
| `opts.heartbeatInterval` | number | undefined | The interval in milliseconds to send a heartbeat to the Access Node. Example: `10000` |
| Name | Type | Description |
| ------------- | --------------------------- | --------------------------------- |
| `eventFilter` | [EventFilter](#eventfilter) | The event filter to subscribe to. |

#### Returns after decoding

Expand Down Expand Up @@ -1565,9 +1559,9 @@ Note:

#### Arguments

| Name | Type | Description |
| ----------- | ------ | ------------------- |
| `eventName` | string | A valid event name. |
| Name | Type | Description |
| ------------------- | ----------------------------------------- | ------------------------------------------------ |
| `eventNameOrFilter` | string | [EventFilter](#eventfilter) | The name of the event or an event filter object. |

#### Returns

Expand Down Expand Up @@ -2017,6 +2011,19 @@ FCL arguments must specify one of the following support types for each value pas

---

### `EventFilter`

An object that contains the parameters to filter events, used for event streaming in the [`fcl.events`](#events) function.

| Name | Value Type | Description |
| ------------------------ | ------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `startBlockId` | string | undefined | The block ID to start listening for events. Example: `9dda5f281897389b99f103a1c6b180eec9dac870de846449a302103ce38453f3` |
| `startHeight` | number | undefined | The block height to start listening for events. Example: `123` |
| `eventTypes` | string[] | undefined | The event types to listen for. Example: `A.7e60df042a9c0868.FlowToken.TokensWithdrawn` |
| `addresses` | string[] | undefined | The addresses to listen for. Example: `0x7e60df042a9c0868` |
| `contracts` | string[] | undefined | The contracts to listen for. Example: `0x7e60df042a9c0868` |
| `opts.heartbeatInterval` | number | undefined | The interval in milliseconds to send a heartbeat to the Access Node. Example: `10000` |

### `StreamConnection`

A stream connection is an object for subscribing to generic data from any WebSocket data stream. This is the base type for all stream connections. Two channels, `close` and `error`, are always available, as they are used to signal the end of the stream and any errors that occur.
Expand Down