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() // 'gif'
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() // 'dollar.jpg'
faker.system.commonFileName('txt') // 'global_borders_wyoming.txt'
Source
commonFileType
Returns a commonly used file type.
Available since v3.1.0
Returns: string
function commonFileType(): string;
Examples
faker.system.commonFileType() // 'audio'
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 |
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() // '45 23 * * 6'
faker.system.cron({ includeYear: true }) // '45 23 * * 6 2067'
faker.system.cron({ includeYear: false }) // '45 23 * * 6'
faker.system.cron({ includeNonStandard: false }) // '45 23 * * 6'
faker.system.cron({ includeNonStandard: true }) // '@yearly'
Source
directoryPath
Returns a directory path.
Available since v3.1.0
Returns: string
function directoryPath(): string;
Examples
faker.system.directoryPath() // '/etc/mail'
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() // 'emf'
faker.system.fileExt('application/json') // 'json'
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() // 'faithfully_calculating.u8mdn'
faker.system.fileName({ extensionCount: 2 }) // 'times_after.swf.ntf'
faker.system.fileName({ extensionCount: { min: 1, max: 2 } }) // 'jaywalk_like_ill.osfpvg'
Source
filePath
Returns a file path.
Available since v3.1.0
Returns: string
function filePath(): string;
Examples
faker.system.filePath() // '/usr/local/src/money.dotx'
Source
fileType
Returns a file type.
Available since v3.1.0
Returns: string
function fileType(): string;
Examples
faker.system.fileType() // 'message'
Source
mimeType
Returns a mime-type.
Available since v3.1.0
Returns: string
function mimeType(): string;
Examples
faker.system.mimeType() // 'video/vnd.vivo'
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 |
options.interfaceType? | 'en' | 'wl' | 'ww' | faker.helpers.arrayElement(['en', 'wl', 'ww']) | The interface type. Can be one of |
Returns: string
function networkInterface(
options: {
interfaceType?: (typeof commonInterfaceTypes)[number];
interfaceSchema?: keyof typeof commonInterfaceSchemas;
} = {}
): string;
Examples
faker.system.networkInterface() // 'enp0s3'
faker.system.networkInterface({ interfaceType: 'wl' }) // 'wlo1'
faker.system.networkInterface({ interfaceSchema: 'mac' }) // 'enx000c29c00000'
faker.system.networkInterface({ interfaceType: 'en', interfaceSchema: 'pci' }) // 'enp5s0f1d0'
Source
semver
Returns a semantic version.
Available since v3.1.0
Returns: string
function semver(): string;
Examples
faker.system.semver() // '1.15.2'