Skip to content

Latest commit

 

History

History
55 lines (41 loc) · 3.45 KB

nifty-tou.md

File metadata and controls

55 lines (41 loc) · 3.45 KB

Home > nifty-tou

nifty-tou package

A delightful little library for working with time-of-use tariffs.

Classes

Class Description
ChronoFieldFormatter Class to parse locale-specific chronological field names of the Gregorian calendar.
ChronoFieldValue A chronological field value.
ChronoTariff A chronologically-based tariff, such as a "daily" charge.
IntRange An immutable number range with min/max values.
NumberFormatter A locale-specific number parser.
TariffRate An identifiable tariff rate.
TemporalRangesTariff

A tariff with time-based range rules.

The rules associated with this tariff are represented by a set of date ranges that serve as the constraints that must be satisfied by a given date for the rule to apply.

TemporalRangesTariffSchedule A schedule, or collection, of TemporalRangesTariff rules that supports resolving rates for dates.
YearTemporalRangesTariff An extension of TemporalRangesTariff with support for an additional year range constraint.
YearTemporalRangesTariffSchedule A schedule, or collection, of YearTemporalRangesTariff rules that supports resolving rates for dates.

Enumerations

Enumeration Description
ChronoField An enumeration of supported chronological fields of the Gregorian calendar.
ChronoTariffUnit An enumeration of supported chronological tariff units of the Gregorian calendar.

Interfaces

Interface Description
Comparable API for a comparison between similar objects.
IntRangeFormatOptions Options to use when formatting in the formatRange() method.
TemporalRangesTariffFormatOptions Options to use when formatting in the formatRange() method.
TemporalRangesTariffScheduleOptions Schedule options.
YearTemporalRangesTariffScheduleOptions Year schedule options.

Namespaces

Namespace Description
Utils

Variables

Variable Description
ALL_VALUES The default "all values" representation.
DEFAULT_FORMAT_OPTIONS Default number format options to use.
UNBOUNDED_RANGE An unbounded range constant.
UNBOUNDED_VALUE The default unbounded display value.