System
Generates fake data for many computer systems properties.
commonFileExt
Returns a commonly used file extension.
Available since v3.1.0
Returns: string
ts
faker.system.commonFileExt(): string
faker.system.commonFileExt() // => "jpg"
faker.system.commonFileExt() // 'gif'
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 |
---|---|---|---|
ext? | string | Extension. Empty string is considered to be not set. |
Returns: string
ts
faker.system.commonFileName(ext?: string): string
faker.system.commonFileName() // => "latin_minivan.mpe"
faker.system.commonFileName() // 'dollar.jpg'
faker.system.commonFileName('txt') // 'global_borders_wyoming.txt'
commonFileType
Returns a commonly used file type.
Available since v3.1.0
Returns: string
ts
faker.system.commonFileType(): string
faker.system.commonFileType() // => "image"
faker.system.commonFileType() // 'audio'
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
ts
faker.system.cron(options: {
includeNonStandard: boolean,
includeYear: boolean
} = {}): string
faker.system.cron() // => "* 14 * * SAT"
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'
directoryPath
Returns a directory path.
Available since v3.1.0
Returns: string
ts
faker.system.directoryPath(): string
faker.system.directoryPath() // => "/root"
faker.system.directoryPath() // '/etc/mail'
fileExt
Returns a file extension.
Available since v3.1.0
Parameters
Name | Type | Default | Description |
---|---|---|---|
mimeType? | string | Valid mime-type |
Returns: string
ts
faker.system.fileExt(mimeType?: string): string
faker.system.fileExt() // => "aas"
faker.system.fileExt() // 'emf'
faker.system.fileExt('application/json') // 'json'
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 | 1 | Define how many extensions the file name should have. A negative number will be treated as |
Returns: string
ts
faker.system.fileName(options: {
extensionCount: number
} = {}): string
faker.system.fileName() // => "latin_minivan.vds"
faker.system.fileName() // 'self_enabling_accountability_toys.kpt'
faker.system.fileName({ extensionCount: 2 }) // 'bike_table.res.vcs'
filePath
Returns a file path.
Available since v3.1.0
Returns: string
ts
faker.system.filePath(): string
faker.system.filePath() // => "/root/male_woman.silo"
faker.system.filePath() // '/usr/local/src/money.dotx'
fileType
Returns a file type.
Available since v3.1.0
Returns: string
ts
faker.system.fileType(): string
faker.system.fileType() // => "model"
faker.system.fileType() // 'message'
mimeType
Returns a mime-type.
Available since v3.1.0
Returns: string
ts
faker.system.mimeType(): string
faker.system.mimeType() // => "application/vnd.patientecommsdoc"
faker.system.mimeType() // 'video/vnd.vivo'
networkInterface
Returns a random network interface.
Available since v7.4.0
Parameters
Name | Type | Default | Description |
---|---|---|---|
options | { ... } | {} | The options to use. |
options.interfaceSchema? | 'index' | 'mac' | 'pci' | 'slot' | The interface schema. Can be one of | |
options.interfaceType? | 'en' | 'wl' | 'ww' | The interface type. Can be one of |
Returns: string
ts
faker.system.networkInterface(options: {
interfaceSchema: 'index' | 'mac' | 'pci' | 'slot',
interfaceType: 'en' | 'wl' | 'ww'
} = {}): string
faker.system.networkInterface() // => "wlxbd9d8d69a674"
faker.system.networkInterface() // 'enp0s3'
faker.system.networkInterface({ interfaceType: 'wl' }) // 'wlo1'
faker.system.networkInterface({ interfaceSchema: 'mac' }) // 'enx000c29c00000'
faker.system.networkInterface({ interfaceType: 'en', interfaceSchema: 'pci' }) // 'enp5s0f1d0'
semver
Returns a semantic version.
Available since v3.1.0
Returns: string
ts
faker.system.semver(): string
faker.system.semver() // => "5.5.7"
faker.system.semver() // '1.1.2'