System

Generates fake data for many computer systems properties.

commonFileExt

Returns a commonly used file extension.

Available since v3.1.0

Returns: string

function commonFileExt(): string;

Examples

faker.system.commonFileExt() // 'jpe'

Source

• View Source

commonFileName

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

Available since v3.1.0

Parameters

Name	Type	Default	Description
extension?	string		The file extension to use. Empty string is considered to be not set.

Returns: string

function commonFileName(extension?: string): string;

Examples

faker.system.commonFileName() // 'tapioca_blaring.pdf'
faker.system.commonFileName('txt') // 'successfully.txt'

Source

• View Source

commonFileType

Returns a commonly used file type.

Available since v3.1.0

Returns: string

function commonFileType(): string;

Examples

faker.system.commonFileType() // 'image'

Source

• View Source

cron

Returns a random cron expression.

Available since v7.5.0

Parameters

Name	Type	Default	Description
options	{ ... }	{}	The optional options to use.
options.includeNonStandard?	boolean	false	Whether to include a @yearly, @monthly, @daily, etc text labels in the generated expression.
options.includeYear?	boolean	false	Whether to include a year in the generated expression.

Returns: string

function cron(
  options: {
    includeYear?: boolean;
    includeNonStandard?: boolean;
  } = {}
): string;

Examples

faker.system.cron() // '* * * * *'
faker.system.cron({ includeYear: true }) // '* * * * 5 *'
faker.system.cron({ includeYear: false }) // '* 22 * * *'
faker.system.cron({ includeNonStandard: false }) // '40 8 14 9 *'
faker.system.cron({ includeNonStandard: true }) // '59 2 7 * 4'

Source

• View Source

directoryPath

Returns a directory path.

Available since v3.1.0

Returns: string

function directoryPath(): string;

Examples

faker.system.directoryPath() // '/root'

Source

• View Source

fileExt

Returns a file extension.

Available since v3.1.0

Parameters

Name	Type	Default	Description
mimeType?	string		Valid mime-type

Returns: string

function fileExt(mimeType?: string): string;

Examples

faker.system.fileExt() // '3g2'
faker.system.fileExt('application/json') // 'map'

Source

• View Source

fileName

Returns a random file name with extension.

Available since v3.1.0

Parameters

Name	Type	Default	Description
options	{ ... }	{}	An options object.
options.extensionCount?	number | { min: number; max: number; }	1	Define how many extensions the file name should have.

Returns: string

function fileName(
  options: {
    extensionCount?:
      | number
      | {
          min: number;
          max: number;
        };
  } = {}
): string;

Examples

faker.system.fileName() // 'tapioca_blaring.lrf'
faker.system.fileName({ extensionCount: 2 }) // 'successfully.distz.ogg'
faker.system.fileName({ extensionCount: { min: 1, max: 2 } }) // 'midst.m2a'

Source

• View Source

filePath

Returns a file path.

Available since v3.1.0

Returns: string

function filePath(): string;

Examples

faker.system.filePath() // '/root/whole_busily_jive.ico'

Source

• View Source

fileType

Returns a file type.

Available since v3.1.0

Returns: string

function fileType(): string;

Examples

faker.system.fileType() // 'image'

Source

• View Source

mimeType

Returns a mime-type.

Available since v3.1.0

Returns: string

function mimeType(): string;

Examples

faker.system.mimeType() // 'audio/midi'

Source

• View Source

networkInterface

Returns a random network interface.

Available since v7.4.0

Parameters

Name	Type	Default	Description
options	{ ... }	{}	The options to use.
options.interfaceSchema?	'index' | 'slot' | 'mac' | 'pci'	faker.helpers.objectKey(['index' | 'slot' | 'mac' | 'pci'])	The interface schema. Can be one of index, slot, mac, pci.
options.interfaceType?	'en' | 'wl' | 'ww'	faker.helpers.arrayElement(['en', 'wl', 'ww'])	The interface type. Can be one of en, wl, ww.

Returns: string

function networkInterface(
  options: {
    interfaceType?: (typeof commonInterfaceTypes)[number];
    interfaceSchema?: keyof typeof commonInterfaceSchemas;
  } = {}
): string;

Examples

faker.system.networkInterface() // 'wlx986a7ef6c89e'
faker.system.networkInterface({ interfaceType: 'wl' }) // 'wlo0'
faker.system.networkInterface({ interfaceSchema: 'mac' }) // 'enxdcdfc7c1a2f8'
faker.system.networkInterface({ interfaceType: 'en', interfaceSchema: 'pci' }) // 'P2enp7s4d6'

Source

• View Source

semver

Returns a semantic version.

Available since v3.1.0

Returns: string

function semver(): string;

Examples

faker.system.semver() // '5.15.12'

Source

• View Source