Skip to content

chore: export ActionFunctionArgs/LoaderFunctionArgs types #8947

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
merged 1 commit into from
Jun 10, 2022
Merged

chore: export ActionFunctionArgs/LoaderFunctionArgs types #8947

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
2 changes: 2 additions & 0 deletions packages/router/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,13 @@ export * from "./router";

export type {
ActionFunction,
ActionFunctionArgs,
DataRouteObject,
FormEncType,
FormMethod,
JsonFunction,
LoaderFunction,
LoaderFunctionArgs,
ParamParseKey,
Params,
PathMatch,
Expand Down
20 changes: 16 additions & 4 deletions packages/router/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,26 +18,38 @@ export interface Submission {
}

/**
* Arguments passed to route loader/action functions
* @private
* Arguments passed to route loader/action functions. Same for now but we keep
* this as a private implementation detail in case they diverge in the future.
*/
export interface DataFunctionArgs {
interface DataFunctionArgs {
request: Request;
params: Params;
signal: AbortSignal;
}

/**
* Arguments passed to loader functions
*/
export interface LoaderFunctionArgs extends DataFunctionArgs {}

/**
* Arguments passed to action functions
*/
export interface ActionFunctionArgs extends DataFunctionArgs {}

/**
* Route loader function signature
*/
export interface LoaderFunction {
(args: DataFunctionArgs): Promise<Response> | Response | Promise<any> | any;
(args: LoaderFunctionArgs): Promise<Response> | Response | Promise<any> | any;
}

/**
* Route action function signature
*/
export interface ActionFunction {
(args: DataFunctionArgs): Promise<Response> | Response | Promise<any> | any;
(args: ActionFunctionArgs): Promise<Response> | Response | Promise<any> | any;
}

/**
Expand Down