Options
All
  • Public
  • Public/Protected
  • All
Menu

A function which takes a value and returns whether it coincides with the desired frequency (based on FrequencyCheck.input and parsed by Parse.frequency). This is loosely tied to a property on the Day object through the FrequencyCheck.property value.

Hierarchy

  • FrequencyCheck

Callable

  • __call(value: number): boolean
  • Tests if the value coincides with the specified frequency.

    Parameters

    • value: number

      The number to test.

    Returns boolean

    true if the value occurs, otherwise false.

Index

Properties

Properties

Optional given

given: boolean

Whether the FrequencyCheck.input given was a valid frequency value and this function will produce desirable results. If given is false, the input was missing or was not valid and this function will always return true.

Optional input

The original input passed to Parse.frequency which generated this function.

Optional property

property: DayProperty

The property on the Day object this function evaluates.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc