IzDateTimePipe | ization Documentation

izDateTime pipe that formats non-zoned input into date & time string

Hierarchy

IzTemporalPipeBase<Temporal.PlainDateTime, SimpleFormat | [SimpleFormat, SimpleFormat] | DateTimeFormatOptions>
- IzDateTimePipe

Implements

PipeTransform

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new IzDateTimePipe(linkService: IzTemporalPluginLinkService, formats: IzTemporalFormats, coreService: IzCoreService, changeDetectorRef: ChangeDetectorRef): IzDateTimePipe

Inherited from IzTemporalPipeBase.constructor
- Defined in temporal/src/lib/pipes/pipe-base.class.ts:17
Parameters
- linkService: IzTemporalPluginLinkService
- formats: IzTemporalFormats
- coreService: IzCoreService
- changeDetectorRef: ChangeDetectorRef
Returns IzDateTimePipe

Properties

Protected formats

formats: IzTemporalFormats

Protected linkService

linkService: IzTemporalPluginLinkService

Methods

convert

convert(input: PlainDateTime, options?: "short" | "medium" | "long" | [SimpleFormat, SimpleFormat] | IntlFormatOptions<"weekday" | "era" | "year" | "month" | "day" | "hour" | "minute" | "second"> | IntlFormatOptions<"dateStyle" | "timeStyle">): string

Inherited from IzTemporalPipeBase.convert
- Defined in temporal/src/lib/pipes/pipe-base.class.ts:26
Actual pipe logic, extend this method to create locale-based pipe.

Parameters
- input: PlainDateTime
- Optional options: "short" | "medium" | "long" | [SimpleFormat, SimpleFormat] | IntlFormatOptions<"weekday" | "era" | "year" | "month" | "day" | "hour" | "minute" | "second"> | IntlFormatOptions<"dateStyle" | "timeStyle">
Returns string

formatTemporal

formatTemporal(input: PlainDateTime, options?: "short" | "medium" | "long" | [SimpleFormat, SimpleFormat] | IntlFormatOptions<"weekday" | "era" | "year" | "month" | "day" | "hour" | "minute" | "second"> | IntlFormatOptions<"dateStyle" | "timeStyle">): string

Overrides IzTemporalPipeBase.formatTemporal
- Defined in temporal/src/lib/pipes/date-time.pipe.ts:16
Extend this method to provide custom pipe logic

Parameters
- input: PlainDateTime
- options: "short" | "medium" | "long" | [SimpleFormat, SimpleFormat] | IntlFormatOptions<"weekday" | "era" | "year" | "month" | "day" | "hour" | "minute" | "second"> | IntlFormatOptions<"dateStyle" | "timeStyle"> = 'medium'
Returns string

transform

transform(input?: PlainDateTime, ...params: [void | "short" | "medium" | "long" | [SimpleFormat, SimpleFormat] | IntlFormatOptions<"weekday" | "era" | "year" | "month" | "day" | "hour" | "minute" | "second"> | IntlFormatOptions<"dateStyle" | "timeStyle">]): string

Implementation of PipeTransform.transform

Inherited from IzTemporalPipeBase.transform
- Defined in core/src/lib/abstract/abstract-pipe.ts:40
Angular Pipe API method that includes memoization. Actual code of the pipe should be implemented in convert method.

Parameters
- Optional input: PlainDateTime
  
  Pipe input
- Rest ...params: [void | "short" | "medium" | "long" | [SimpleFormat, SimpleFormat] | IntlFormatOptions<"weekday" | "era" | "year" | "month" | "day" | "hour" | "minute" | "second"> | IntlFormatOptions<"dateStyle" | "timeStyle">]
  
  Pipe params
Returns string

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

linkService: IzTemporalPluginLinkService

formats: IzTemporalFormats

coreService: IzCoreService

changeDetectorRef: ChangeDetectorRef

Returns IzDateTimePipe

Properties

Protected formats

Protected linkService

Methods

convert

Parameters

input: PlainDateTime

Optional options: "short" | "medium" | "long" | [SimpleFormat, SimpleFormat] | IntlFormatOptions<"weekday" | "era" | "year" | "month" | "day" | "hour" | "minute" | "second"> | IntlFormatOptions<"dateStyle" | "timeStyle">

Returns string

formatTemporal

Parameters

input: PlainDateTime

options: "short" | "medium" | "long" | [SimpleFormat, SimpleFormat] | IntlFormatOptions<"weekday" | "era" | "year" | "month" | "day" | "hour" | "minute" | "second"> | IntlFormatOptions<"dateStyle" | "timeStyle"> = 'medium'

Returns string

transform

Parameters

Optional input: PlainDateTime

Rest ...params: [void | "short" | "medium" | "long" | [SimpleFormat, SimpleFormat] | IntlFormatOptions<"weekday" | "era" | "year" | "month" | "day" | "hour" | "minute" | "second"> | IntlFormatOptions<"dateStyle" | "timeStyle">]

Returns string