IzDatePipe | ization Documentation

izDate pipe that formats non-zoned input into date string

Hierarchy

IzTemporalPipeBase<Temporal.PlainDate | Temporal.PlainDateTime, SimpleFormat | DateFormatOptions>
- IzDatePipe

Implements

PipeTransform

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

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 IzDatePipe

Properties

Protected formats

formats: IzTemporalFormats

Protected linkService

linkService: IzTemporalPluginLinkService

Methods

convert

convert(input: PlainDate | PlainDateTime, options?: "short" | "medium" | "long" | IntlFormatOptions<"weekday" | "era" | "year" | "month" | "day"> | IntlFormatOptions<"dateStyle">): 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: PlainDate | PlainDateTime
- Optional options: "short" | "medium" | "long" | IntlFormatOptions<"weekday" | "era" | "year" | "month" | "day"> | IntlFormatOptions<"dateStyle">
Returns string

formatTemporal

formatTemporal(input: PlainDate | PlainDateTime, options?: "short" | "medium" | "long" | IntlFormatOptions<"weekday" | "era" | "year" | "month" | "day"> | IntlFormatOptions<"dateStyle">): string

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

Parameters
- input: PlainDate | PlainDateTime
- options: "short" | "medium" | "long" | IntlFormatOptions<"weekday" | "era" | "year" | "month" | "day"> | IntlFormatOptions<"dateStyle"> = 'medium'
Returns string

transform

transform(input?: PlainDate | PlainDateTime, ...params: [void | "short" | "medium" | "long" | IntlFormatOptions<"weekday" | "era" | "year" | "month" | "day"> | IntlFormatOptions<"dateStyle">]): 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: PlainDate | PlainDateTime
  
  Pipe input
- Rest ...params: [void | "short" | "medium" | "long" | IntlFormatOptions<"weekday" | "era" | "year" | "month" | "day"> | IntlFormatOptions<"dateStyle">]
  
  Pipe params
Returns string

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

linkService: IzTemporalPluginLinkService

formats: IzTemporalFormats

coreService: IzCoreService

changeDetectorRef: ChangeDetectorRef

Returns IzDatePipe

Properties

Protected formats

Protected linkService

Methods

convert

Parameters

input: PlainDate | PlainDateTime

Optional options: "short" | "medium" | "long" | IntlFormatOptions<"weekday" | "era" | "year" | "month" | "day"> | IntlFormatOptions<"dateStyle">

Returns string

formatTemporal

Parameters

input: PlainDate | PlainDateTime

options: "short" | "medium" | "long" | IntlFormatOptions<"weekday" | "era" | "year" | "month" | "day"> | IntlFormatOptions<"dateStyle"> = 'medium'

Returns string

transform

Parameters

Optional input: PlainDate | PlainDateTime

Rest ...params: [void | "short" | "medium" | "long" | IntlFormatOptions<"weekday" | "era" | "year" | "month" | "day"> | IntlFormatOptions<"dateStyle">]

Returns string