feat(@remix-run/cloudflare,@remix-run/deno,@remix-run/node): SerializeFrom utility for loader and action type inference
#4013
Conversation
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
🦋 Changeset detectedLatest commit: 65aceb4 The changes in this PR will be included in the next version bump. This PR includes changesets to release 16 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
pcattori
force-pushed
the
pedro/serialized-from
branch
3 times, most recently
from
bed12e9 to
c512e1d
Compare
pcattori
force-pushed
the
pedro/serialized-from
branch
from
c512e1d to
377512a
Compare
pcattori
commented
Aug 17, 2022
|
|
||
| function isEqual<A, B>( | ||
| arg: A extends B ? (B extends A ? true : false) : false | ||
| ): void {} | ||
|
|
||
| // not sure why `eslint` thinks the `T` generic is not used... | ||
| // eslint-disable-next-line @typescript-eslint/no-unused-vars | ||
| type LoaderData<T> = ReturnType<typeof useLoaderData<T>>; |
There was a problem hiding this comment.
note: this test is for testing useLoaderData's types, so we actually grab types from useLoaderData instead of assuming its using UseDataFunctionReturn or SerializeFrom.
pcattori
force-pushed
the
pedro/serialized-from
branch
2 times, most recently
from
7e2556c to
fc97ee4
Compare
pcattori
changed the title
SerializeFrom utility for loader and action type inferenceSerializeFrom utility for loader and action type inference
pcattori
commented
Aug 18, 2022
| @@ -32,7 +32,6 @@ export type { | |||
| CookieParseOptions, | |||
| CookieSerializeOptions, | |||
| CookieSignatureOptions, | |||
| CreateRequestHandlerFunction, | |||
There was a problem hiding this comment.
CreateRequestHandlerFunction is a utility for authoring Remix runtime packages and was incorrectly re-exported before.
pcattori
commented
Aug 18, 2022
pcattori
commented
Aug 18, 2022
pcattori
commented
Aug 18, 2022
| @@ -28,7 +28,6 @@ export type { | |||
| IsSessionFunction, | |||
| JsonFunction, | |||
| RedirectFunction, | |||
| TypedResponse, | |||
There was a problem hiding this comment.
The interface section of exports is for types related to values/functions that should be exported by every server runtime pkg. We use the fetch API for request/response, so we don't export our own request/response implementations from server runtime pkgs.
Therefore, TypedResponse should not be considered part of the server runtime interface.
TBH the distinction between "interface" and "re-export" is subtle and I'd much prefer to not need re-exports at all once we have a pkg for exporting runtime-agnostic stuff.
chaance
requested changes
Aug 18, 2022
pcattori
force-pushed
the
pedro/serialized-from
branch
from
acecb4c to
bb68c13
Compare
convention is to use plurals for collections (e.g. arrays), not for unions
arrays are technically `object`s, so we need something more specific. `Record<PropertyKey, unknown>` should match any object, but not match arrays.
…ToOptional` more obvious that this _converts_ `undefined` unions to optionals
…utility and to be consistent with `SerializeObject`
and provide comments to explain what tuples are and how `object` matches classes
makes each line in the type definition independent of other lines. more readable and easier to comment/uncomment specific conditions. plus less git noise when adding/removing/reordering conditions.
…izeFrom` since the type can be used without `useLoaderData` or `useActionData` and just returns the JSON serialized data from a loader or action
…at _is_ being used
…SerializeFrom` type utility also, sync re-exports from `@remix-run/server-runtime`
pcattori
force-pushed
the
pedro/serialized-from
branch
from
bb68c13 to
65aceb4
Compare
MichaelDeBoey
added
package:server-runtime
runtime:node
runtime:cloudflare
renderer:react
runtime:deno
awaiting release
This was referenced Aug 24, 2022
MichaelDeBoey
removed
the
awaiting release
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Renamed internal
UseDataFunctionReturntype toSerializeFromsince its can be used withoutuseLoaderDataanduseActionData. A bunch of small type cleanups + bug fixes. Moved serialize type utilities to@remix-run/server-runtimeand re-exportingSerializeFromandTypedResponsefrom each runtime pkg.Testing Strategy:
@remix-run/react@remix-run/server-runtimeand@remix-run/node, importedSerializedFromfrom@remix-run/node, and got the correct type in VS Code