Class IzTemporalPipeBase<Input, Param>

Base class for all pipes in this module. Formatting logic is provided by each pipe via formatTemporal.

Type parameters

Input

Pipe input - one or several Temporal datatypes supported by the pipe
Param

Pipe param - supported param combination for the pipe

Hierarchy

IzAbstractPipe<Input, [Param | void]>
- IzTemporalPipeBase

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new IzTemporalPipeBase<Input, Param>(linkService: IzTemporalPluginLinkService, formats: IzTemporalFormats, coreService: IzCoreService, changeDetectorRef: ChangeDetectorRef): IzTemporalPipeBase<Input, Param>

Overrides IzAbstractPipe.constructor
- Defined in temporal/src/lib/pipes/pipe-base.class.ts:17
Type parameters
- Input
- Param
Parameters
- linkService: IzTemporalPluginLinkService
- formats: IzTemporalFormats
- coreService: IzCoreService
- changeDetectorRef: ChangeDetectorRef
Returns IzTemporalPipeBase<Input, Param>

Properties

Protected formats

formats: IzTemporalFormats

Protected linkService

linkService: IzTemporalPluginLinkService

Methods

convert

convert(input: Input, options?: Param): string

Overrides IzAbstractPipe.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: Input
- Optional options: Param
Returns string

Protected Abstract formatTemporal

formatTemporal(input: Input, options?: Param): string

- Defined in temporal/src/lib/pipes/pipe-base.class.ts:34
Extend this method to provide custom pipe logic

Parameters
- input: Input
- Optional options: Param
Returns string

transform

transform(input?: Input, ...params: [void | Param]): string

Inherited from IzAbstractPipe.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: Input
  
  Pipe input
- Rest ...params: [void | Param]
  
  Pipe params
Returns string

Generated using TypeDoc