Skip to content

Commit 0bdc31b

Browse files
committedMay 15, 2024··
docs: update links in JSDocs
1 parent 8a4309c commit 0bdc31b

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed
 

‎packages/next-safe-action/src/safe-action-client.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,8 @@ class SafeActionClient<ServerError, Ctx = undefined, Metadata = undefined> {
8888
* Define the input validation schema for the action.
8989
* @param schema Input validation schema
9090
* @param utils Optional utils object
91-
* @returns
91+
*
92+
* {@link https://next-safe-action.dev/docs/safe-action-client/instance-methods#schema See docs for more information}
9293
*/
9394
schema<S extends Schema | undefined = undefined, FVE = ValidationErrors<S>>(
9495
schema?: S,

‎packages/next-safe-action/src/status.ts

+8-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ import type { HookActionStatus } from "./hooks.types";
33
/**
44
* Returns true if the action is idle.
55
* @param status
6-
* @returns
6+
*
7+
* {@link https://next-safe-action.dev/docs/execution/hooks/check-action-status#utility-functions See docs for more information}
78
*/
89
export function isIdle(status: HookActionStatus): status is "idle" {
910
return status === "idle";
@@ -12,7 +13,8 @@ export function isIdle(status: HookActionStatus): status is "idle" {
1213
/**
1314
* Returns true if the action is executing.
1415
* @param status
15-
* @returns
16+
*
17+
* {@link https://next-safe-action.dev/docs/execution/hooks/check-action-status#utility-functions See docs for more information}
1618
*/
1719
export function isExecuting(status: HookActionStatus): status is "executing" {
1820
return status === "executing";
@@ -21,7 +23,8 @@ export function isExecuting(status: HookActionStatus): status is "executing" {
2123
/**
2224
* Returns true if the action has succeeded.
2325
* @param status
24-
* @returns
26+
*
27+
* {@link https://next-safe-action.dev/docs/execution/hooks/check-action-status#utility-functions See docs for more information}
2528
*/
2629
export function hasSucceeded(status: HookActionStatus): status is "hasSucceeded" {
2730
return status === "hasSucceeded";
@@ -30,7 +33,8 @@ export function hasSucceeded(status: HookActionStatus): status is "hasSucceeded"
3033
/**
3134
* Returns true if the action has errored.
3235
* @param status
33-
* @returns
36+
*
37+
* {@link https://next-safe-action.dev/docs/execution/hooks/check-action-status#utility-functions See docs for more information}
3438
*/
3539
export function hasErrored(status: HookActionStatus): status is "hasErrored" {
3640
return status === "hasErrored";

0 commit comments

Comments
 (0)
Please sign in to comment.