Function: useLiveView()

Call Signature

useLiveView<V, R>(view, ref): R extends null | undefined ? R : Readonly<ViewSelection<V> extends Selection<ViewEntityWithTypename<V>> ? Mask<ViewEntityWithTypename<V>, { [K in string | number | symbol as K extends "__typename" ? never : K]?: DeferrableSelectionFieldValue<ViewEntityWithTypename<V>, K> } & object & SelectionViewSpread<ViewEntityWithTypename<V>> & object & ViewSelection<V>> : ViewEntityWithTypename<V> & object>

Defined in: react-fate/src/useLiveView.tsx:28

Resolves a reference against a view and subscribes to live server updates for that selection.

Type Parameters

V

V extends View<any, any>

R

R extends Readonly<{ __typename: ViewEntityName; [ViewsTag]: Set<string>; id: string | number; }> | null | undefined

Parameters

view

V

ref

R

Returns

R extends null | undefined ? R : Readonly<ViewSelection<V> extends Selection<ViewEntityWithTypename<V>> ? Mask<ViewEntityWithTypename<V>, { [K in string | number | symbol as K extends "__typename" ? never : K]?: DeferrableSelectionFieldValue<ViewEntityWithTypename<V>, K> } & object & SelectionViewSpread<ViewEntityWithTypename<V>> & object & ViewSelection<V>> : ViewEntityWithTypename<V> & object>

Example

const post = useLiveView(PostView, postRef);

Call Signature

useLiveView<V, R>(view, ref): R extends null | undefined ? R : Readonly<ViewSelection<V> extends Selection<ViewEntityWithTypename<V>> ? Mask<ViewEntityWithTypename<V>, { [K in string | number | symbol as K extends "__typename" ? never : K]?: DeferrableSelectionFieldValue<ViewEntityWithTypename<V>, K> } & object & SelectionViewSpread<ViewEntityWithTypename<V>> & object & ViewSelection<V>> : ViewEntityWithTypename<V> & object>

Defined in: react-fate/src/useLiveView.tsx:35

Resolves a reference against a view and subscribes to live server updates for that selection.

Type Parameters

V

V extends View<any, any>

R

R extends Deferred<Readonly<{ __typename: ViewEntityName; [ViewsTag]: Set<string>; id: string | number; }>> | null | undefined

Parameters

view

V

ref

R

Returns

R extends null | undefined ? R : Readonly<ViewSelection<V> extends Selection<ViewEntityWithTypename<V>> ? Mask<ViewEntityWithTypename<V>, { [K in string | number | symbol as K extends "__typename" ? never : K]?: DeferrableSelectionFieldValue<ViewEntityWithTypename<V>, K> } & object & SelectionViewSpread<ViewEntityWithTypename<V>> & object & ViewSelection<V>> : ViewEntityWithTypename<V> & object>

Example

const post = useLiveView(PostView, postRef);