Skip to content

Commit 44f8c25

Browse files
committed
docs: update jsdoc comments
1 parent 5380f95 commit 44f8c25

File tree

5 files changed

+4
-5
lines changed

5 files changed

+4
-5
lines changed

packages/next-safe-action/src/hooks.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ export const useAction = <ServerError, S extends StandardSchemaV1 | undefined, C
144144
/**
145145
* Use the action from a Client Component via hook, with optimistic data update.
146146
* @param safeActionFn The action function
147-
* @param utils Required `currentData` and `updateFn` and optional base utils and callbacks
147+
* @param utils Required `currentData` and `updateFn` and optional callbacks
148148
*
149149
* {@link https://next-safe-action.dev/docs/execute-actions/hooks/useoptimisticaction See docs for more information}
150150
*/

packages/next-safe-action/src/middleware.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import type { MiddlewareFn } from "./index.types";
55
* properties, if you need one or all of them to be typed. The type for each property that is passed as generic is the
66
* **minimum** shape required to define the middleware function, but it can also be larger than that.
77
*
8-
* {@link https://next-safe-action.dev/docs/define-actions/middleware#create-standalone-middleware-with-createmiddleware See docs for more information}
8+
* {@link https://next-safe-action.dev/docs/define-actions/middleware#create-standalone-middleware See docs for more information}
99
*/
1010
export const createMiddleware = <BaseData extends { serverError?: any; ctx?: object; metadata?: any }>() => {
1111
return {

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,6 @@ export class SafeActionClient<
106106
/**
107107
* Define the bind args input validation schema for the action.
108108
* @param bindArgsSchemas Bind args input validation schemas
109-
* @param utils Optional utils object
110109
*
111110
* {@link https://next-safe-action.dev/docs/define-actions/instance-methods#bindargsschemas See docs for more information}
112111
*/

packages/next-safe-action/src/stateful-hooks.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import type { InferInputOrDefault, StandardSchemaV1 } from "./standard-schema";
99
/**
1010
* Use the stateful action from a Client Component via hook. Used for actions defined with [`stateAction`](https://next-safe-action.dev/docs/define-actions/instance-methods#action--stateaction).
1111
* @param safeActionFn The action function
12-
* @param utils Optional `initResult`, `permalink`, base utils and callbacks
12+
* @param utils Optional `initResult`, `permalink` and callbacks
1313
* @deprecated Directly use `useActionState` hook from `react` instead.
1414
*
1515
* {@link https://next-safe-action.dev/docs/execute-actions/hooks/usestateaction See docs for more information}

packages/next-safe-action/src/validation-errors.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ export function formatValidationErrors<VE extends ValidationErrors<any>>(validat
109109
* Emulation of `zod`'s [`flatten`](https://zod.dev/ERROR_HANDLING?id=flattening-errors) function.
110110
* @param {ValidationErrors} [validationErrors] Validation errors object
111111
*
112-
* {@link https://next-safe-action.dev/docs/define-actions/validation-errors#flattenvalidationerrors-and-flattenbindargsvalidationerrors-utility-functions See docs for more information}
112+
* {@link https://next-safe-action.dev/docs/define-actions/validation-errors#flattenvalidationerrorsutility-function See docs for more information}
113113
*/
114114
export function flattenValidationErrors<VE extends ValidationErrors<any>>(validationErrors: VE) {
115115
const flattened: FlattenedValidationErrors<VE> = {

0 commit comments

Comments
 (0)