docs: update links in JSDocs

TheEdoRan · May 15, 2024 · 0bdc31b · 0bdc31b
1 parent 8a4309c
commit 0bdc31b
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 5 deletions.
diff --git a/packages/next-safe-action/src/safe-action-client.ts b/packages/next-safe-action/src/safe-action-client.ts
@@ -88,7 +88,8 @@ class SafeActionClient<ServerError, Ctx = undefined, Metadata = undefined> {
 	 * Define the input validation schema for the action.
 	 * @param schema Input validation schema
 	 * @param utils Optional utils object
-	 * @returns
+	 *
+	 * {@link https://next-safe-action.dev/docs/safe-action-client/instance-methods#schema See docs for more information}
 	 */
 	schema<S extends Schema | undefined = undefined, FVE = ValidationErrors<S>>(
 		schema?: S,

diff --git a/packages/next-safe-action/src/status.ts b/packages/next-safe-action/src/status.ts
@@ -3,7 +3,8 @@ import type { HookActionStatus } from "./hooks.types";
 /**
  * Returns true if the action is idle.
  * @param status
- * @returns
+ *
+ * {@link https://next-safe-action.dev/docs/execution/hooks/check-action-status#utility-functions See docs for more information}
  */
 export function isIdle(status: HookActionStatus): status is "idle" {
 	return status === "idle";
@@ -12,7 +13,8 @@ export function isIdle(status: HookActionStatus): status is "idle" {
 /**
  * Returns true if the action is executing.
  * @param status
- * @returns
+ *
+ * {@link https://next-safe-action.dev/docs/execution/hooks/check-action-status#utility-functions See docs for more information}
  */
 export function isExecuting(status: HookActionStatus): status is "executing" {
 	return status === "executing";
@@ -21,7 +23,8 @@ export function isExecuting(status: HookActionStatus): status is "executing" {
 /**
  * Returns true if the action has succeeded.
  * @param status
- * @returns
+ *
+ * {@link https://next-safe-action.dev/docs/execution/hooks/check-action-status#utility-functions See docs for more information}
  */
 export function hasSucceeded(status: HookActionStatus): status is "hasSucceeded" {
 	return status === "hasSucceeded";
@@ -30,7 +33,8 @@ export function hasSucceeded(status: HookActionStatus): status is "hasSucceeded"
 /**
  * Returns true if the action has errored.
  * @param status
- * @returns
+ *
+ * {@link https://next-safe-action.dev/docs/execution/hooks/check-action-status#utility-functions See docs for more information}
  */
 export function hasErrored(status: HookActionStatus): status is "hasErrored" {
 	return status === "hasErrored";