Skip to content

Commit 67c87ac

Browse files
committed
docs: corrected the description of the properties closes logaretm#124
1 parent 3113a98 commit 67c87ac

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

docs/content/api/use-subscription.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,13 @@ The `useSubscription` function allows you to execute GraphQL subscriptions, it r
1010

1111
The `useSubscription` function returns the following properties and functions:
1212

13-
| Property | Type | Description |
14-
| -------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
15-
| data | `Ref<any/null>` | The GraphQL mutation result's `data` |
16-
| error | `Ref<CombinedError>` | Any errors encountered during mutation execution |
17-
| execute | `({variables: object}) => Promise<OperationResult<TData>>` | Executes the mutation and returns the operation result containing `data` and `error` values |
18-
| isPaused | `Ref<boolean>` | True if the subscription is paused or inactive |
19-
| pause | `() => void` | Deactivates the subscription temporarily until `resume` is called |
20-
| resume | `() => void` | Activates the subscription |
13+
| Property | Type | Description |
14+
| -------- | -------------------- | ----------------------------------------------------------------- |
15+
| data | `Ref<any/null>` | The GraphQL subscription result's `data` |
16+
| error | `Ref<CombinedError>` | Any errors encountered during subscription execution |
17+
| isPaused | `Ref<boolean>` | True if the subscription is paused or inactive |
18+
| pause | `() => void` | Deactivates the subscription temporarily until `resume` is called |
19+
| resume | `() => void` | Activates the subscription |
2120

2221
## Usage
2322

0 commit comments

Comments
 (0)