Commerce

Module to generate commerce and product related entries.

Overview

For a long product name like 'Incredible Soft Gloves', use productName(). The product names are generated from a list of adjectives, materials, and products, which can each be accessed separately using productAdjective(), productMaterial(), and product(). You can also create a description using productDescription().

For a department in a shop or product category, use department().

You can also create a price using price().

department

Returns a department inside a shop.

Available since v3.0.0

Returns: string

function department(): string;
faker.commerce.department() // 'Garden'

Source

• View Source

isbn

Returns a random ISBN identifier.

Available since v8.1.0

Parameters

Name	Type	Default	Description
options	10 | 13 | { ... }	{}	The variant to return or an options object.
options.separator?	string	'-'	The separator to use in the format.
options.variant?	10 | 13	13	The variant of the identifier to return. Can be either 10 (10-digit format) or 13 (13-digit format).

Returns: string

function isbn(
    options:
      | 10
      | 13
      | {
          variant?: 10 | 13;
          separator?: string;
        } = {}
  ): string;
faker.commerce.isbn() // '978-0-692-82459-7'
faker.commerce.isbn(10) // '1-155-36404-X'
faker.commerce.isbn(13) // '978-1-60808-867-6'
faker.commerce.isbn({ separator: ' ' }) // '978 0 452 81498 1'
faker.commerce.isbn({ variant: 10, separator: ' ' }) // '0 940319 49 7'
faker.commerce.isbn({ variant: 13, separator: ' ' }) // '978 1 6618 9122 0'

Source

• View Source

price

Generates a price between min and max (inclusive).

To better represent real-world prices, when options.dec is greater than 0, the final decimal digit in the returned string will be generated as follows:

• 50% of the time: 9
• 30% of the time: 5
• 10% of the time: 0
• 10% of the time: a random digit from 0 to 9

Available since v3.0.0

Parameters

Name	Type	Default	Description
options	{ ... }	{}	An options object.
options.dec?	number	2	The number of decimal places.
options.max?	number	1000	The maximum price.
options.min?	number	1	The minimum price.
options.symbol?	string	''	The currency value to use.

Returns: string

function price(
    options: {
      min?: number;
      max?: number;
      dec?: number;
      symbol?: string;
    } = {}
  ): string;
faker.commerce.price() // 828.07
faker.commerce.price({ min: 100 }) // 904.19
faker.commerce.price({ min: 100, max: 200 }) // 154.55
faker.commerce.price({ min: 100, max: 200, dec: 0 }) // 133
faker.commerce.price({ min: 100, max: 200, dec: 0, symbol: '$' }) // $114

Source

• View Source

product

Returns a short product name.

Available since v3.0.0

Returns: string

function product(): string;
faker.commerce.product() // 'Computer'

Source

• View Source

productAdjective

Returns an adjective describing a product.

Available since v3.0.0

Returns: string

function productAdjective(): string;
faker.commerce.productAdjective() // 'Handcrafted'

Source

• View Source

productDescription

Returns a product description.

Available since v5.0.0

Returns: string

function productDescription(): string;
faker.commerce.productDescription() // 'Andy shoes are designed to keeping...'

Source

• View Source

productMaterial

Returns a material of a product.

Available since v3.0.0

Returns: string

function productMaterial(): string;
faker.commerce.productMaterial() // 'Rubber'

Source

• View Source

productName

Generates a random descriptive product name.

Available since v3.0.0

Returns: string

function productName(): string;
faker.commerce.productName() // 'Incredible Soft Gloves'

Source

• View Source