Skip to content

[react] Add types for experimental_use #62189

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

Merged
johnnyreilly merged 1 commit into from
Sep 10, 2022
Merged

[react] Add types for experimental_use #62189

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
27 changes: 27 additions & 0 deletions types/react/experimental.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,31 @@ declare module '.' {
* @see https://reactjs.org/docs/concurrent-mode-patterns.html#suspenselist
*/
export const SuspenseList: ExoticComponent<SuspenseListProps>;

interface ThenableImpl<T> {
then(onFulfill: (value: T) => unknown, onReject: (error: unknown) => unknown): void | PromiseLike<unknown>;
}
interface UntrackedThenable<T> extends ThenableImpl<T> {
status?: void;
}

export interface PendingThenable<T> extends ThenableImpl<T> {
status: 'pending';
}

export interface FulfilledThenable<T> extends ThenableImpl<T> {
status: 'fulfilled';
value: T;
}

export interface RejectedThenable<T> extends ThenableImpl<T> {
status: 'rejected';
reason: unknown;
}

export type Thenable<T> = UntrackedThenable<T> | PendingThenable<T> | FulfilledThenable<T> | RejectedThenable<T>;

export type Usable<T> = Thenable<T> | Context<T>;

export function experimental_use<T>(usable: Usable<T>): T;
}
16 changes: 16 additions & 0 deletions types/react/test/experimental.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,19 @@ function suspenseTest() {
<React.Suspense fallback="Loading">A</React.Suspense>
<React.Suspense fallback="Loading">B</React.Suspense>
</React.SuspenseList>;

const contextUsers = React.createContext(['HAL']);
const promisedUsers = Promise.resolve(['Dave']);

function useUse() {
// @ts-expect-error Missing value
React.experimental_use();

// $ExpectType string[]
const users = React.experimental_use(promisedUsers);
// @ts-expect-error incompatible type. Mainly to potentially inspect TypeScript error message
React.experimental_use({});

// $ExpectType string[]
const contextValue = React.experimental_use(contextUsers);
}