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

Jump to bottom

Document live value lifetime #4831

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −0
Open

Document live value lifetime #4831

Show file tree
Hide file tree
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
2 changes: 2 additions & 0 deletions website/docs/guides/relay-resolvers/live-fields.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,8 @@ export type LiveState<T> = {
};
```

The `subscribe` method's return value is an unsubscribe function. Relay will call this when it no longer needs to be notified of changes to the live state. Today this happens when the field is eligible for [garbage collection](../../guided-tour/reusing-cached-data/presence-of-data.md#garbage-collection).

## Creating a LiveState Object

In most cases, you will want to define a helper function that reads your reactive data store and returns a `LiveState` object. For example, you for a Redux store you might write a wrapper that exposes a `LiveState` for a given selector:
Expand Down
2 changes: 2 additions & 0 deletions website/versioned_docs/version-v18.0.0/guides/relay-resolvers/live-fields.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,8 @@ export type LiveState<T> = {
};
```

The `subscribe` method's return value is an unsubscribe function. Relay will call this when it no longer needs to be notified of changes to the live state. Today this happens when the field is eligible for [garbage collection](../../guided-tour/reusing-cached-data/presence-of-data.md#garbage-collection).

## Creating a LiveState Object

In most cases, you will want to define a helper function that reads your reactive data store and returns a `LiveState` object. For example, you for a Redux store you might write a wrapper that exposes a `LiveState` for a given selector:
Expand Down
Loading