Skip to content

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

ts
faker.commerce.department(): string
faker.commerce.department() // 'Garden'

isbn

Returns a random ISBN identifier.

Available since v8.1.0

Parameters

NameTypeDefaultDescription
options10 | 13 | { ... }{}

The variant to return or an options object.

options.separator?string'-'

The separator to use in the format.

options.variant?10 | 1313

The variant of the identifier to return. Can be either 10 (10-digit format) or 13 (13-digit format).

Returns: string

ts
faker.commerce.isbn(options: 10 | 13 | {
  separator: string,
  variant: 10 | 13
} = {}): 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'

price

Generates a price between min and max (inclusive).

Available since v3.0.0

Parameters

NameTypeDefaultDescription
options?number | { ... }{}

The minimum price or on options object.

options.dec?number2

The number of decimal places.

options.max?number1000

The maximum price.

options.min?number1

The minimum price.

options.symbol?string''

The currency value to use.

legacyMax?number1000

The maximum price. This argument is deprecated.

legacyDec?number2

The number of decimal places. This argument is deprecated.

legacySymbol?string''

The currency value to use. This argument is deprecated.

Returns: string

ts
faker.commerce.price(options?: number | {
  dec: number,
  max: number,
  min: number,
  symbol: string
} = {}, legacyMax?: number = 1000, legacyDec?: number = 2, legacySymbol?: string = ''): string
faker.commerce.price() // 828.00
faker.commerce.price({ min: 100 }) // 904.00
faker.commerce.price({ min: 100, max: 200 }) // 154.00
faker.commerce.price({ min: 100, max: 200, dec: 0 }) // 133
faker.commerce.price({ min: 100, max: 200, dec: 0, symbol: '$' }) // $114

product

Returns a short product name.

Available since v3.0.0

Returns: string

ts
faker.commerce.product(): string
faker.commerce.product() // 'Computer'

productAdjective

Returns an adjective describing a product.

Available since v3.0.0

Returns: string

ts
faker.commerce.productAdjective(): string
faker.commerce.productAdjective() // 'Handcrafted'

productDescription

Returns a product description.

Available since v5.0.0

Returns: string

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

productMaterial

Returns a material of a product.

Available since v3.0.0

Returns: string

ts
faker.commerce.productMaterial(): string
faker.commerce.productMaterial() // 'Rubber'

productName

Generates a random descriptive product name.

Available since v3.0.0

Returns: string

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

Released under the MIT License.