Class ChronoTariff

A chronologically-based tariff, such as a "daily" charge.

Hierarchy

ChronoTariff

Index

Constructors

Properties

#name? #rate #unit

Accessors

Methods

#dayQuantity #monthQuantity #timeFraction #weekQuantity quantity

Constructors

constructor

new ChronoTariff(chronoUnit, rate, name?): ChronoTariff
Constructor.
Parameters
- chronoUnit: ChronoTariffUnit
  
  the chrono unit
- rate: number
  
  the rate per chrono unit
- Optional name: string
  
  an optional description
Returns ChronoTariff
- Defined in ChronoTariff.ts:37

Properties

`Private` `Optional` #name

#name?: string

An optional name to associate with the tariff.

`Private` #rate

#rate: number

The rate applied per time unit.

`Private` #unit

#unit: ChronoTariffUnit

The tariff time unit.

Accessors

name

get name(): undefined | string
Get the optional name.

Returns undefined | string
- Defined in ChronoTariff.ts:54

rate

get rate(): number
Get the rate.

Returns number
- Defined in ChronoTariff.ts:49

unit

get unit(): ChronoTariffUnit
Get the unit.

Returns ChronoTariffUnit
- Defined in ChronoTariff.ts:44

Methods

`Private` #dayQuantity

#dayQuantity(from, to, utc?): number
Parameters
- from: Date
- to: Date
- Optional utc: boolean
Returns number
- Defined in ChronoTariff.ts:112

`Private` #monthQuantity

#monthQuantity(from, to, utc?): number
Parameters
- from: Date
- to: Date
- Optional utc: boolean
Returns number
- Defined in ChronoTariff.ts:243

`Private` #timeFraction

#timeFraction(from, to, refFrom?, refTo?): number
Parameters
- from: Date
- to: Date
- Optional refFrom: Date
- Optional refTo: Date
Returns number
- Defined in ChronoTariff.ts:101

`Private` #weekQuantity

#weekQuantity(from, to, utc?): number
Parameters
- from: Date
- to: Date
- Optional utc: boolean
Returns number
- Defined in ChronoTariff.ts:167

quantity

quantity(from, to, utc?): number
Calcualte the count of units between two dates.

The cost of this tariff can be calculated by multiplying the rate by the result of this method, for example:
```
const tariff = new ChronoTariff(ChronoTariffUnit.DAYS, 10);
tariff.rate * tariff.quantity(
    new Date('2024-01-01T00:00:00Z'),
    new Date('2024-01-08T00:00:00Z'),
    true) === 70; // 7 days @ 10/day
```
Parameters
- from: Date
  
  the starting date
- to: Date
  
  the ending date (exclusive)
- Optional utc: boolean
  
  if true then use UTC date components, otherwise assume the local time zone
Returns number
the count of units between from and to, including any fractional component
- Defined in ChronoTariff.ts:77

Generated using TypeDoc