Method networkInterface

src/modules/system/index.ts:249–304

* Returns a random [network interface](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/networking_guide/sec-understanding_the_predictable_network_interface_device_names). * * @param options The options to use. * @param options.interfaceType The interface type.

(
    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;
    } = {}
  )

   * @since 7.4.0
   */
  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 {
    const {
      interfaceType = this.faker.helpers.arrayElement(commonInterfaceTypes),
      interfaceSchema = this.faker.helpers.objectKey(commonInterfaceSchemas),
    } = options;

    let suffix: string;
    let prefix = '';
    switch (interfaceSchema) {
      case 'index': {
        suffix = this.faker.string.numeric();
        break;
      }

      case 'slot': {
        suffix = `${this.faker.string.numeric()}${
          this.faker.helpers.maybe(() => `f${this.faker.string.numeric()}`) ??
          ''
        }${this.faker.helpers.maybe(() => `d${this.faker.string.numeric()}`) ?? ''}`;
        break;
      }

      case 'mac': {
        suffix = this.faker.internet.mac('');
        break;
      }

      case 'pci': {
        prefix =
          this.faker.helpers.maybe(() => `P${this.faker.string.numeric()}`) ??
          '';
        suffix = `${this.faker.string.numeric()}s${this.faker.string.numeric()}${
          this.faker.helpers.maybe(() => `f${this.faker.string.numeric()}`) ??
          ''
        }${this.faker.helpers.maybe(() => `d${this.faker.string.numeric()}`) ?? ''}`;
        break;
      }
    }

    return `${prefix}${interfaceType}${commonInterfaceSchemas[interfaceSchema]}${suffix}`;
  }

  /**