Git Product home page Git Product logo

Comments (4)

kiliman avatar kiliman commented on May 18, 2024 3

Yeah, there will always be some friction when adding future API without breaking the existing types. At least TypeScript has a way to override these type definitions.

In addition, I think Remix needs to add ones for the updated LoaderFunctionArgs and ActionFunctionArgs so that response is not optional (since it isn't when single fetch is enabled).

#9326

from remix.

rphlmr avatar rphlmr commented on May 18, 2024 1

Possible fix:
Add a ClientLoaderFunctionArgs_SingleFetch to use instead of ClientLoaderFunctionArgs?

type ClientLoaderFunctionArgs_SingleFetch = Omit<
  ClientLoaderFunctionArgs,
  "serverLoader"
> & {
  serverLoader: <T = AppData>() => ReturnType<T>;
};

type ClientLoaderFunction_SingleFetch = ((
  args: ClientLoaderFunctionArgs_SingleFetch,
) => ReturnType<LoaderFunction_SingleFetch>) & {
  hydrate?: boolean;
};

type ClientActionFunctionArgs_SingleFetch = Omit<
  ClientActionFunctionArgs,
  "serverLoader"
> & {
  serverLoader: <T = AppData>() => ReturnType<T>;
};

type ClientActionFunction_SingleFetch = (
  args: ActionLoaderFunctionArgs_SingleFetch,
) => ReturnType<ActionFunction_SingleFetch>;

Then, add it on hooks

type SingleFetchSerialize_V2<T extends LoaderFunction_SingleFetch | ActionFunction_SingleFetch | ClientLoaderFunction_SingleFetch | ClientActionFunction_SingleFetch> =
    Awaited<ReturnType<T>> extends TypedDeferredData<infer D> ? D :
        Awaited<ReturnType<T>> extends TypedResponse<Record<string, unknown>> ? SerializeFrom<T> :
            Awaited<ReturnType<T>>;

declare module "@remix-run/react" {
  export function useLoaderData<T>(): T extends
    | LoaderFunction_SingleFetch
    | ClientLoaderFunction_SingleFetch
    ? SingleFetchSerialize_V2<T>
    : never;

  export function useActionData<T>(): T extends
    | ActionFunction_SingleFetch
    | ClientActionFunction_SingleFetch
    ? SingleFetchSerialize_V2<T>
    : never;

  export function useRouteLoaderData<T>(
    routeId: string,
  ): T extends LoaderFunction_SingleFetch | ClientLoaderFunction_SingleFetch
    ? SingleFetchSerialize_V2<T>
    : never;

  export function useFetcher<TData = unknown>(
    opts?: Parameters<typeof useFetcherRR>[0],
  ): FetcherWithComponents<
    TData extends
      | LoaderFunction_SingleFetch
      | ActionFunction_SingleFetch
      | ClientLoaderFunction_SingleFetch
      | ClientActionFunction_SingleFetch
      ? SingleFetchSerialize_V2<TData>
      : never
  >;
}

from remix.

rphlmr avatar rphlmr commented on May 18, 2024

The reason is single-fetch.d.ts.

  export function useLoaderData<T>(): T extends LoaderFunction_SingleFetch
    ? SingleFetchSerialize_V2<T>
    : never;

  export function useActionData<T>(): T extends ActionFunction_SingleFetch
    ? SingleFetchSerialize_V2<T>
    : never;

  type LoaderFunction_SingleFetch = (
    args: LoaderFunctionArgs
  ) => Promise<DataFunctionReturnValue> | DataFunctionReturnValue;

  type ActionFunction_SingleFetch = (
    args: ActionFunctionArgs
  ) => Promise<DataFunctionReturnValue> | DataFunctionReturnValue;

Extends for the generics of useLoaderData and useActionData don't match with args of clientLoader (ClientLoaderFunctionArgs)

from remix.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.