Skip to content
Source
Sign inSign up
TanStack/router
Open History to see the last commit

awaited.tsx

55 lines1.4 KB

1import * as React from 'react'
2​
3import { TSR_DEFERRED_PROMISE, defer } from '@tanstack/router-core'
4import { reactUse } from './utils'
5​
6export type AwaitOptions<T> = {
7 promise: Promise<T>
8}
9​
10/** Suspend until a deferred promise resolves or rejects and return its data. */
11export function useAwaited<T>({ promise: _promise }: AwaitOptions<T>): T {
12 if (reactUse) {
13 const data = reactUse(_promise)
14 return data
15 }
16 const promise = defer(_promise)
17​
18 if (promise[TSR_DEFERRED_PROMISE].status === 'pending') {
19 throw promise
20 }
21​
22 if (promise[TSR_DEFERRED_PROMISE].status === 'error') {
23 throw promise[TSR_DEFERRED_PROMISE].error
24 }
25​
26 return promise[TSR_DEFERRED_PROMISE].data
28​
29/**
30 * Component that suspends on a deferred promise and renders its child with
31 * the resolved value. Optionally provides a Suspense fallback.
32 */
33export function Await<T>(
34 props: AwaitOptions<T> & {
35 fallback?: React.ReactNode
36 children: (result: T) => React.ReactNode
37 },
38) {
39 const inner = <AwaitInner {...props} />
40 if (props.fallback) {
41 return <React.Suspense fallback={props.fallback}>{inner}</React.Suspense>
42 }
43 return inner
45​
46function AwaitInner<T>(
47 props: AwaitOptions<T> & {
48 fallback?: React.ReactNode
49 children: (result: T) => React.ReactNode
50 },
51): React.JSX.Element {
52 const data = useAwaited(props)
53​
54 return props.children(data) as React.JSX.Element