Carrot reference
Functions

pluralize()

Given a value of type String, returns that value in plural form.

Syntax

pluralize(number, singular[, plural])

  • number - the specified number of instances of the evaluated string.
  • singular - the singular form of the evaluated string.
  • plural (optional) - the plural form of the evaluated string.
  • Return type: String

Sample usage

pluralize(10, "banana") returns "bananas".

pluralize(1, "address", "addresses") returns "address".

pluralize(10, "address", "addresses") returns "addresses"'.

Supported data types

Input type

Return type

Logic

Number, String

String

If a Number value greater than 1, or less than 1, and a single String value are passed, the String value will be returned with an s appended to it. If a Number value of 1 is passed, the String value will remain in singular form.

Number , String (x2)

String

If a Number value greater than 1, or less than 1, and two String value are passed, including the optional parameter, the second String value will be returned. If a Number value of 1 is passed, the String value will remain in singular form.

Unsupported data types

Null

Unsupported data types return Null.



Updated 04 Oct 2023
Doc contributor
Doc contributor
Did this page help you?