Skip to content

Commit

Permalink
add clarification about resetting the return value when switching on …
Browse files Browse the repository at this point in the history
…`ignoreResults` later
  • Loading branch information
phryneas committed Jul 8, 2024
1 parent d7afc64 commit d82c489
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/react/types/types.documentation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -533,6 +533,8 @@ export interface SubscriptionOptionsDocumentation {

/**
* If `true`, the hook will not cause the component to rerender. This is useful when you want to control the rendering of your component yourself with logic in the `onData` and `onError` callbacks.
*
* Changing this to `true` when the hook already had `data` will reset the `data` to `undefined`.
*/
ignoreResults: unknown;
/**
Expand Down

0 comments on commit d82c489

Please sign in to comment.