Fix JSDoc errors after merge with main

Author: fabian-hiller

library/src/methods/brand/brand.ts

@@ -35,6 +35,14 @@ export type SchemaWithBrand<
   };
 };
 
+/**
+ * Brands the output type of a schema.
+ *
+ * @param schema The scheme to be branded.
+ * @param name The brand name.
+ *
+ * @returns The branded schema.
+ */
 export function brand<
   TSchema extends BaseSchema | BaseSchemaAsync,
   TName extends BrandName

library/src/methods/transform/transform.ts

@@ -14,6 +14,16 @@ export type SchemaWithTransform<TSchema extends BaseSchema, TOutput> = Omit<
   };
 };
 
+/**
+ * Adds a transformation step to a schema, which is executed at the end of
+ * parsing and can change the output type.
+ *
+ * @param schema The schema to be used.
+ * @param action The transformation action.
+ * @param pipe A validation pipe.
+ *
+ * @returns A transformed schema.
+ */
 export function transform<TSchema extends BaseSchema, TOutput>(
   schema: TSchema,
   action: (value: Output<TSchema>) => TOutput,

library/src/methods/transform/transformAsync.ts

@@ -24,6 +24,16 @@ export type SchemaWithTransformAsync<
   };
 };
 
+/**
+ * Adds an async transformation step to a schema, which is executed at the end
+ * of parsing and can change the output type.
+ *
+ * @param schema The schema to be used.
+ * @param action The transformation action.
+ * @param pipe A validation pipe.
+ *
+ * @returns A transformed schema.
+ */
 export function transformAsync<
   TSchema extends BaseSchema | BaseSchemaAsync,
   TOutput

library/src/schemas/nullish/nullish.ts

@@ -33,7 +33,6 @@ export type NullishSchema<
  * Creates a nullish schema.
  *
  * @param wrapped The wrapped schema.
- * @param default_ The default value.
  *
  * @returns A nullish schema.
  */

library/src/schemas/union/unionAsync.ts

@@ -41,7 +41,7 @@ export type UnionSchemaAsync<
 /**
  * Creates an async union schema.
  *
- * @param union The union options.
+ * @param options The union options.
  * @param message The error message.
  *
  * @returns An async union schema.

library/src/types/pipe.ts

@@ -47,11 +47,11 @@ export type BaseValidation<TInput = any> = {
   /**
    * Parses unknown input based on its requirement.
    *
-   * @internal This is an internal API.
-   *
    * @param input The input to be parsed.
    *
    * @returns The parse result.
+   *
+   * @internal
    */
   _parse(input: TInput): PipeResult<TInput>;
 };
@@ -71,11 +71,11 @@ export type BaseValidationAsync<TInput = any> = {
   /**
    * Parses unknown input based on its requirement.
    *
-   * @internal This is an internal API.
-   *
    * @param input The input to be parsed.
    *
    * @returns The parse result.
+   *
+   * @internal
    */
   _parse(input: TInput): Promise<PipeResult<TInput>>;
 };
@@ -91,11 +91,11 @@ export type BaseTransformation<TInput = any> = {
   /**
    * Parses unknown input based on its requirement.
    *
-   * @internal This is an internal API.
-   *
    * @param input The input to be parsed.
    *
    * @returns The parse result.
+   *
+   * @internal
    */
   _parse(input: TInput): PipeResult<TInput>;
 };
@@ -111,11 +111,11 @@ export type BaseTransformationAsync<TInput = any> = {
   /**
    * Parses unknown input based on its requirement.
    *
-   * @internal This is an internal API.
-   *
    * @param input The input to be parsed.
    *
    * @returns The parse result.
+   *
+   * @internal
    */
   _parse(input: TInput): Promise<PipeResult<TInput>>;
 };

library/src/types/schema.ts

@@ -43,18 +43,18 @@ export type BaseSchema<TInput = any, TOutput = TInput> = {
   /**
    * Parses unknown input based on its schema.
    *
-   * @internal This is an internal API.
-   *
    * @param input The input to be parsed.
    * @param info The parse info.
    *
    * @returns The parse result.
+   *
+   * @internal
    */
   _parse(input: unknown, info?: ParseInfo): _ParseResult<TOutput>;
   /**
    * Input and output type.
    *
-   * @internal This is an internal API.
+   * @internal
    */
   _types?: { input: TInput; output: TOutput };
 };
@@ -70,18 +70,18 @@ export type BaseSchemaAsync<TInput = any, TOutput = TInput> = {
   /**
    * Parses unknown input based on its schema.
    *
-   * @internal This is an internal API.
-   *
    * @param input The input to be parsed.
    * @param info The parse info.
    *
    * @returns The parse result.
+   *
+   * @internal
    */
   _parse(input: unknown, info?: ParseInfo): Promise<_ParseResult<TOutput>>;
   /**
    * Input and output type.
    *
-   * @internal This is an internal API.
+   * @internal
    */
   _types?: { input: TInput; output: TOutput };
 };

library/src/utils/getPipeIssues/getPipeIssues.ts

@@ -8,6 +8,7 @@ import { getIssues } from '../getIssues/getIssues.ts';
  * @param validation The validation name.
  * @param message The error message.
  * @param input The input value.
+ * @param requirement The requirement.
  *
  * @returns The pipeline result object.
  */