Class IzWeekdayPipe

izWeekday pipe that formats non-zoned input into weekday string

Hierarchy

IzTemporalPipeBase<Temporal.PlainDate | Temporal.PlainDateTime, SimpleFormat | WeekdayFormatOptions>
- IzWeekdayPipe

Implements

PipeTransform

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

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 IzWeekdayPipe

Properties

Protected formats

formats: IzTemporalFormats

Protected linkService

linkService: IzTemporalPluginLinkService

Methods

convert

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

formatTemporal

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

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

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

transform

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

Generated using TypeDoc