Interface Spacetime

types/types.d.ts:4–300

/** a date/timezone object */
export interface Spacetime {
  /**
   * @deprecated use toNativeDate. This is an implementation detail that was not intended for external use
   * @returns the date as a native date object
   */
  d: Date

  /** @returns epoch in milliseconds */
  epoch: number

  /** @returns whether warnings are enabled */
  silent: boolean

  /** @returns the timezone tz database name, eg, 'america/denver'  */
  tz: string

  /** @returns the tz database nameset  */
  timezones: TimezoneSet

  /** move to a new timezone, but at this same moment. Accepts an IANA code or abbreviation */
  goto: (target: string | null) => Spacetime

  /** @returns a copy of this object, with no references to the original */
  clone: () => Spacetime

  /**
   * @deprecated use toNativeDate()
   * @returns the native Date object at the same epoch
   */
  toLocalDate(): Date

  /** @returns the native Date object at the same epoch */
  toNativeDate(): Date

  /** @returns a bunch of meta-data about your current timezone  */
  timezone(): TimezoneMeta
  /** swap the timezone, but keep the same date-time (if possible) */
  timezone(tz: String): Spacetime

  /** output nicely-formatted strings */
  format: (format: Format) => string

  /** output formatted string using unix formatting code (yyyy.MM.dd h:mm a) */
  unixFmt: (format: string) => string

  /** move to the first millisecond of the day, week, month, year, etc. */
  startOf: (unit: TimeUnit) => Spacetime

  /** move to the last millisecond of the day, week, month, year, etc. */
  endOf: (unit: TimeUnit) => Spacetime

  /** increment the time by a number and unit - like an hour, minute, day, or year */
  add: (value: number, unit: TimeUnit) => Spacetime

  /** decrease the time by a number and unit - like an hour, minute, day, or year */
  subtract: (value: number, unit: TimeUnit) => Spacetime

  /** go to the beginning of the next unit */