SkytimesUtils

Utilities for skytimes

Index

Constructors

• constructor

Methods

• allEventDetails
• getAllTimes
• getEventDetails
• getEventStatus
• getNextEventOccurrence

Constructors

constructor

• new SkytimesUtils(): SkytimesUtils

• Returns SkytimesUtils

Methods

publicstaticallEventDetails

• allEventDetails(): [EventKey, EventDetails][]

• Same as getEventDetails but for all of the events

  ---

  Returns [EventKey, EventDetails][]

  An array of event details

publicstaticgetAllTimes

• getAllTimes(eventTime: DateTime<boolean>, interval?: number): string

• Get all occurrences of an event for the given date

  ---

  Parameters

  Name	Type	Default	Description
  eventTime	DateTime<boolean>		The DateTime for which to get all occurrences
  optionalinterval	number		The interval between the event occurrences

  Returns string

publicstaticgetEventDetails

• getEventDetails(key: EventKey): EventDetails

• Get the details about an event, their status, next occurrence, all occurrences for the day

  ---

  Parameters

  Name	Type	Default	Description
  key	EventKey		The event key

  Returns EventDetails

publicstaticgetEventStatus

• getEventStatus(event: EventData, nextOccurrence: DateTime<boolean>): Times

• Returns the event status of a given event

  ---

  Parameters

  Name	Type	Default	Description
  event	EventData		The event to get the status for
  nextOccurrence	DateTime<boolean>		The next occurrence of the event relative to "now"

  Returns Times

  The event status (or null if there is no active duration)

publicstaticgetNextEventOccurrence

• getNextEventOccurrence(eventName: EventKey): DateTime<boolean>

• Get the next occurrence of the event relative to now

  ---

  Parameters

  Name	Type	Default	Description
  eventName	EventKey		The key of the event

  Returns DateTime<boolean>