MetaArgs should be renamed to MetaFunctionArgs to match the rest of remix API types

[lifeiscontent]

Reproduction

the API Surface in Remix should be guessable.

System Info

N/A

Used Package Manager

pnpm

Expected Behavior

ActionFunction <-> ActionArgs
Loaderfunction <-> LoaderArgs
MetaFunction <-> MetaArgs

or

ActionFunction <-> ActionFunctionArgs
Loaderfunction <-> LoaderFunctionArgs
MetaFunction <-> MetaFunctionArgs

Actual Behavior

MetaArgs is inconsistent with the rest of the remix API

[kiliman]

I'm not sure if it was intentional or accidental.

MetaArgs is different from LoaderFunctionArgs in that:

1. It's an interface and not a type
2. It's also a generic type (used to type data and matches)

export function meta({
  data,
  params,
  location,
  matches,
}: MetaArgs<
  typeof loader, // current route loader data type
  {
    "root": typeof rootLoader;      // specify types for parent loader matches
    "routes/parent": typeof parentLoader;
  }
>) {
  console.log(data, params, location, matches);
  const m = matches.find((m) => m.id === "routes/parent");
  console.log(m?.data.name);
  return [
    { title: "New Remix App" },
    { name: "description", content: "Welcome to Remix!" },
  ];
}

[lifeiscontent]

@kiliman yep, I'm aware, just a suggestion so devs can look at the docs less 😅

[lifeiscontent]

@kiliman just out of curiosity do you happen to know why its an interface? are there reasons to do declaration merging on the interface?

[kiliman]

No, I'm not sure of the reasoning behind it.

Anyway, it looks like the naming was an oversight. In the Remix v2.0 release, they renamed LoaderArgs => LoaderFunctionArgs. They might have forgotten to do the same for MetaArgs.

https://github.com/remix-run/remix/blob/main/CHANGELOG.md#:~:text=Renamed%20LoaderArgs/ActionArgs%20to%20LoaderFunctionArgs/ActionFunctionArgs

In fairness, the meta function also underwent a breaking change in v2, since now it returns an array instead of an object with keys.

https://remix.run/docs/en/main/start/v2#route-meta

[kiliman]

I think they could just add the MetaFunctionArgs as an alias, deprecate MetaArgs, and drop it in v3.