docs: jsdoc for options (#1644)

1 files changed, 35 insertions, 2 deletions

diff --git a/src/modules/system/index.ts b/src/modules/system/index.ts
index e5413622..2f3ce371 100644
--- a/src/modules/system/index.ts
+++ b/src/modules/system/index.ts
@@ -63,9 +63,22 @@ export class SystemModule {
   fileName(
     options: {
       /**
-       * Define how many extensions the file name should have. Defaults to `1`.
+       * Define how many extensions the file name should have.
+       *
+       * @default 1
        */
-      extensionCount?: number | { min: number; max: number };
+      extensionCount?:
+        | number
+        | {
+            /**
+             * Minimum number of extensions.
+             */
+            min: number;
+            /**
+             * Maximum number of extensions.
+             */
+            max: number;
+          };
     } = {}
   ): string {
     const { extensionCount = 1 } = options;
@@ -250,7 +263,17 @@ export class SystemModule {
    */
   networkInterface(
     options: {
+      /**
+       * The interface type. Can be one of `en`, `wl`, `ww`.
+       *
+       * @default faker.helpers.arrayElement(['en', 'wl', 'ww'])
+       */
       interfaceType?: (typeof commonInterfaceTypes)[number];
+      /**
+       * The interface schema. Can be one of `index`, `slot`, `mac`, `pci`.
+       *
+       * @default faker.helpers.objectKey(['index' | 'slot' | 'mac' | 'pci'])
+       */
       interfaceSchema?: keyof typeof commonInterfaceSchemas;
     } = {}
   ): string {
@@ -303,7 +326,17 @@ export class SystemModule {
    */
   cron(
     options: {
+      /**
+       * Whether to include a year in the generated expression.
+       *
+       * @default false
+       */
       includeYear?: boolean;
+      /**
+       * Whether to include a @yearly, @monthly, @daily, etc text labels in the generated expression.
+       *
+       * @default false
+       */
       includeNonStandard?: boolean;
     } = {}
   ): string {