Method fileName

src/modules/system/index.ts:53–90

* Returns a random file name with extension. * * @param options An options object. * @param options.extensionCount Define how many extensions the file name should have. Defaults to `1`. * * @example * faker.system.fileName() // 'faithfully_calculating.u8mdn' * faker.system.fileN

(
    options: {
      /**
       * Define how many extensions the file name should have.
       *
       * @default 1
       */
      extensionCount?:
        | number
        | {
            /**
             * Minimum number of extensions.
             */
            min: number;
            /**
             * Maximum number of extensions.
             */
            max: number;
          };
    } = {}
  )

   * @since 3.1.0
   */
  fileName(
    options: {
      /**
       * Define how many extensions the file name should have.
       *
       * @default 1
       */
      extensionCount?:
        | number
        | {
            /**
             * Minimum number of extensions.
             */
            min: number;
            /**
             * Maximum number of extensions.
             */
            max: number;
          };
    } = {}
  ): string {
    const { extensionCount = 1 } = options;

    const baseName = this.faker.word
      .words()
      .toLowerCase()
      .replaceAll(/\W/g, '_');

    const extensionsSuffix = this.faker.helpers
      .multiple(() => this.fileExt(), { count: extensionCount })
      .join('.');

    if (extensionsSuffix.length === 0) {
      return baseName;
    }

    return `${baseName}.${extensionsSuffix}`;
  }

  /**
   * Returns a random file name with a given extension or a commonly used extension.