@kubb/core 1.14.0-canary.20231018T192916 → 1.14.0

package/dist/index.d.cts

@@ -481,7 +481,7 @@ type KubbUserConfig = Omit<KubbConfig, 'root' | 'plugins'> & {
     plugins?: Array<KubbPlugin> | Array<KubbJSONPlugins> | KubbObjectPlugins;
 };
 /**
- * Global/internal config used through out the full generation.
+ * @private
  */
 type KubbConfig = {
     /**
@@ -492,27 +492,28 @@ type KubbConfig = {
     root: string;
     input: {
         /**
-         * Path to be used as the input. Can be an absolute path, or a path relative from
-         * the defined root option.
+         * Path to be used as the input. This can be an absolute path or a path relative to the `root`.
          */
         path: string;
     } | {
         /**
-         * String or object containing the data that you would normally import.
+         * `string` or `object` containing the data.
          */
         data: string | unknown;
     };
     output: {
         /**
-         * Path to be used to export all generated files. Can be an absolute path, or a path relative based of the defined root option.
+         * Path to be used to export all generated files.
+         * This can be an absolute path, or a path relative based of the defined `root` option.
          */
         path: string;
         /**
-         * Remove previous generated files and folders.
+         * Clean output directory before each build.
          */
         clean?: boolean;
         /**
-         * Enabled or disable the writing to the filesystem. This is being used for the playground.
+         * Write files to the fileSystem
+         * This is being used for the playground.
          * @default true
          */
         write?: boolean;
@@ -528,8 +529,8 @@ type KubbConfig = {
      */
     hooks?: {
         /**
-         * Hook that will be triggerend at the end of all executions.
-         * Useful for running Prettier or ESLint to use your own linting structure.
+         * Hook that will be triggered at the end of all executions.
+         * Useful for running Prettier or ESLint to format/lint your code.
          */
         done?: string | Array<string>;
     };

package/dist/index.d.ts

@@ -481,7 +481,7 @@ type KubbUserConfig = Omit<KubbConfig, 'root' | 'plugins'> & {
     plugins?: Array<KubbPlugin> | Array<KubbJSONPlugins> | KubbObjectPlugins;
 };
 /**
- * Global/internal config used through out the full generation.
+ * @private
  */
 type KubbConfig = {
     /**
@@ -492,27 +492,28 @@ type KubbConfig = {
     root: string;
     input: {
         /**
-         * Path to be used as the input. Can be an absolute path, or a path relative from
-         * the defined root option.
+         * Path to be used as the input. This can be an absolute path or a path relative to the `root`.
          */
         path: string;
     } | {
         /**
-         * String or object containing the data that you would normally import.
+         * `string` or `object` containing the data.
          */
         data: string | unknown;
     };
     output: {
         /**
-         * Path to be used to export all generated files. Can be an absolute path, or a path relative based of the defined root option.
+         * Path to be used to export all generated files.
+         * This can be an absolute path, or a path relative based of the defined `root` option.
          */
         path: string;
         /**
-         * Remove previous generated files and folders.
+         * Clean output directory before each build.
          */
         clean?: boolean;
         /**
-         * Enabled or disable the writing to the filesystem. This is being used for the playground.
+         * Write files to the fileSystem
+         * This is being used for the playground.
          * @default true
          */
         write?: boolean;
@@ -528,8 +529,8 @@ type KubbConfig = {
      */
     hooks?: {
         /**
-         * Hook that will be triggerend at the end of all executions.
-         * Useful for running Prettier or ESLint to use your own linting structure.
+         * Hook that will be triggered at the end of all executions.
+         * Useful for running Prettier or ESLint to format/lint your code.
          */
         done?: string | Array<string>;
     };