Skip to content

Commit

Permalink
docs: update website links in JSDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
TheEdoRan committed May 7, 2024
1 parent 87b13b4 commit 4ea8559
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion packages/next-safe-action/src/action-builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ export function actionBuilder<
action: buildAction({ withState: false }).action,

/**
* Define the stateful action. To be used with the [`useStateAction`](https://next-safe-action.dev/docs/usage/hooks/usestateaction) hook.
* Define the stateful action. To be used with the [`useStateAction`](https://next-safe-action.dev/docs/execution/hooks/usestateaction) hook.
* @param serverCodeFn Code that will be executed on the **server side**
*
* {@link https://next-safe-action.dev/docs/safe-action-client/instance-methods#action--stateaction See docs for more information}
Expand Down
10 changes: 5 additions & 5 deletions packages/next-safe-action/src/hooks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import type {
HookCallbacks,
HookResult,
HookSafeActionFn,
HookStateSafeActionFn,
HookSafeStateActionFn,
} from "./hooks.types";
import { EMPTY_HOOK_RESULT, isError } from "./utils";

Expand Down Expand Up @@ -104,7 +104,7 @@ const useActionCallbacks = <
* @param safeActionFn The action function
* @param utils Optional callbacks
*
* {@link https://next-safe-action.dev/docs/usage/hooks/useaction See docs for more information}
* {@link https://next-safe-action.dev/docs/execution/hooks/useaction See docs for more information}
*/
export const useAction = <
ServerError,
Expand Down Expand Up @@ -174,7 +174,7 @@ export const useAction = <
* @param safeActionFn The action function
* @param utils Required `currentData` and `updateFn` and optional callbacks
*
* {@link https://next-safe-action.dev/docs/usage/hooks/useoptimisticaction See docs for more information}
* {@link https://next-safe-action.dev/docs/execution/hooks/useoptimisticaction See docs for more information}
*/
export const useOptimisticAction = <
ServerError,
Expand Down Expand Up @@ -259,7 +259,7 @@ export const useOptimisticAction = <
* @param safeActionFn The action function
* @param utils Optional `initResult`, `permalink` and callbacks
*
* {@link https://next-safe-action.dev/docs/usage/hooks/usestateaction See docs for more information}
* {@link https://next-safe-action.dev/docs/execution/hooks/usestateaction See docs for more information}
*/
export const useStateAction = <
ServerError,
Expand All @@ -269,7 +269,7 @@ export const useStateAction = <
FBAVE,
Data,
>(
safeActionFn: HookStateSafeActionFn<ServerError, S, BAS, FVE, FBAVE, Data>,
safeActionFn: HookSafeStateActionFn<ServerError, S, BAS, FVE, FBAVE, Data>,
utils?: {
initResult?: Awaited<ReturnType<typeof safeActionFn>>;
permalink?: string;
Expand Down
2 changes: 1 addition & 1 deletion packages/next-safe-action/src/safe-action-client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ class SafeActionClient<ServerError, Ctx = undefined, Metadata = undefined> {

/**
* Define the stateful action (without input validation schema, bind arguments validation schemas or metadata).
* To be used with the [`useStateAction`](https://next-safe-action.dev/docs/usage/hooks/usestateaction) hook.
* To be used with the [`useStateAction`](https://next-safe-action.dev/docs/execution/hooks/usestateaction) hook.
* @param serverCodeFn Code that will be executed on the **server side**
*
* {@link https://next-safe-action.dev/docs/safe-action-client/instance-methods#action--stateaction See docs for more information}
Expand Down

0 comments on commit 4ea8559

Please sign in to comment.