Skip to content

@serenity-is/corelib / format

Variable: format()

format: (format, ...prm) => string = stringFormat

Defined in: src/compat/formatting-compat.ts:44

Legacy alias for stringFormat (format).

Formats a string by replacing {index[:format]} placeholders with the supplied arguments, using Culture for locale-aware value formatting.

Parameters

format

string

Composite format string (e.g. "Hello {0}, you have {1:n2} messages"). {{ / }} are escaped to a single brace.

prm

...any[]

Values to substitute; each may be a number, Date, or any object with a format(formatSpec, locale) method. Nullish values render as empty strings.

Returns

string

The formatted string.

Example

stringFormat("Hello {0}, balance {1:c}", "Alice", 1234.5); // uses Culture currency symbol

Deprecated

Use stringFormat directly.

See

stringFormat