@serenity-is/corelib / DateTimeFormatter

Class: DateTimeFormatter

Defined in: src/ui/formatters/datetimeformatter.ts:5

Variant of DateFormatter that defaults to Culture.dateTimeFormat.

Extends

• DateFormatter

Constructors

Constructor

new DateTimeFormatter(props): DateTimeFormatter

Defined in: src/ui/formatters/datetimeformatter.ts:12

Creates a new DateTimeFormatter.

Parameters

props

Formatter options.

displayFormat?

string

Date-time format string (default Culture.dateTimeFormat).

Returns

DateTimeFormatter

Overrides

DateFormatter.constructor

Properties

props

readonly props: object = {}

Defined in: src/ui/formatters/dateformatter.ts:14

Formatter options.

displayFormat?

optional displayFormat: string

Inherited from

DateFormatter.props

---

[typeInfo]

static [typeInfo]: FormatterTypeInfo<"Serenity.">

Defined in: src/ui/formatters/datetimeformatter.ts:6

Overrides

DateFormatter.[typeInfo]

Accessors

displayFormat

Get Signature

get displayFormat(): string

Defined in: src/ui/formatters/dateformatter.ts:50

Gets the date display format.

Returns

string

The display format string.

Set Signature

set displayFormat(value): void

Defined in: src/ui/formatters/dateformatter.ts:55

Sets the date display format.

Parameters

value

string

The display format string.

Returns

void

Inherited from

DateFormatter.displayFormat

Methods

format()

format(ctx): string

Defined in: src/ui/formatters/dateformatter.ts:62

Formats the cell value as a date string.

Parameters

ctx

FormatterContext

Formatter context containing the cell value.

Returns

string

HTML-encoded formatted date string.

Inherited from

DateFormatter.format

---

format()

static format(value, format?): any

Defined in: src/ui/formatters/dateformatter.ts:25

Static helper to format any date-like value.

Parameters

value

any

Date instance or ISO string.

format?

string

Format string (defaults to culture format).

Returns

any

HTML-encoded formatted string.

Inherited from

DateFormatter.format