-
Notifications
You must be signed in to change notification settings - Fork 2.6k
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.
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
opt-in type inference for single-fetch #9272
Merged
Merged
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
5222956
opt-in type inference for single-fetch
pcattori 6c4c589
Update single fetch type overrides to handle json/defer
brophdawg11 053ed4c
Update docs
brophdawg11 4bca4dd
Add type handling for useFetcher, useMatches, meta
brophdawg11 06c9623
Add back in return type narrowing
brophdawg11 73d8199
Update docs
brophdawg11 ab40ad7
Update changeset
brophdawg11 f66de1a
Update docs
brophdawg11 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
"@remix-run/react": patch | ||
--- | ||
|
||
Opt-in types for single-fetch | ||
|
||
To opt-in to type inference for single-fetch, add `future/single-fetch.d.ts` to `include` in your `tsconfig.json`: | ||
|
||
```json | ||
{ | ||
"include": [ | ||
"./node_modules/@remix-run/react/future/single-fetch.d.ts" | ||
] | ||
} | ||
``` | ||
|
||
This changes `useLoaderData` and `useActionData` types to return single-fetch aware types instead of `SerializedFrom` types: | ||
|
||
|
||
```ts | ||
const loader = () => { | ||
return { hello: "world", date: new Date() } | ||
} | ||
|
||
// Without opting into single-fetch types | ||
// Types from `loader` are serialized via `JSON.stringify` and `JSON.parse` | ||
const before = useLoaderData<typeof loader>(); | ||
// ^? { hello: string, date: string } | ||
|
||
// Opting into single-fetch types | ||
// Types from `loader` are serialized via `turbo-stream` | ||
const after = useLoaderData<typeof loader>(); | ||
// ^? { hello: string, date: Date } | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
import type { AppLoadContext } from "@remix-run/server-runtime"; | ||
|
||
type Serializable = | ||
| undefined | ||
| null | ||
| boolean | ||
| string | ||
| symbol | ||
| number | ||
| Array<Serializable> | ||
| { [key: PropertyKey]: Serializable } | ||
| bigint | ||
| Date | ||
| URL | ||
| RegExp | ||
| Error | ||
| Map<Serializable, Serializable> | ||
| Set<Serializable> | ||
| Promise<Serializable>; | ||
|
||
type Params<Key extends string = string> = { | ||
readonly [key in Key]: string | undefined; | ||
}; | ||
|
||
type ResponseStub = { | ||
status?: number; | ||
headers: Headers; | ||
}; | ||
|
||
type DataFunction = ( | ||
args: { | ||
request: Request; | ||
params: Params; | ||
context: AppLoadContext; | ||
response: ResponseStub; | ||
}, | ||
handlerCtx?: unknown | ||
) => Serializable; | ||
|
||
type Loader = DataFunction & { hydrate?: boolean }; | ||
type Action = DataFunction; | ||
|
||
declare module "@remix-run/react" { | ||
export function useLoaderData<T>(): T extends Loader | ||
? Awaited<ReturnType<T>> | ||
: never; | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We will need to fork in here and use the old |
||
export function useActionData<T>(): T extends Action | ||
? Awaited<ReturnType<T>> | ||
: never; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I really like this API.