Class HSpan

constructor

• new HSpan(
      args:
          | RelativeSpan
          | SingleDateSpan
          | DoubleDateSpan
          | DoubleDateTimeSpan,
  ): HSpan

• Construct a new span.

  Parameters

  • args: RelativeSpan | SingleDateSpan | DoubleDateSpan | DoubleDateTimeSpan

  Returns HSpan

Optional Readonlyend

Optional Readonlymode

Optional Readonlystart

Readonlytimezone

isRelative

• isRelative(): boolean

• Returns boolean

  True if the span is relative.

toAxon

• toAxon(): string

• Returns string

  an Axon representation of this span.

toJSON

• toJSON(): SpanJsonData

• Returns SpanJsonData

  A JSON representation of a span.

toLuxonInterval

• toLuxonInterval<IntervalType>(
      __namedParameters: {
          DateTime: any;
          Interval: { fromDateTimes(start: any, end: any): IntervalType };
      },
      _now?: Date,
  ): IntervalType

• Convert the span to a Luxon interval.

  The haystack-core has zero runtime dependencies and supports web, node and deno environments. However vanilla JavaScript lacks support for various calendar functions required to make HSpan useful.

  Warning: at the time of writing, the first day of the week does not vary between locales with Luxon.

  import { DateTime, Interval } from 'luxon'
  
  ...
  const interval = new HSpan({ mode: SpanMode.today })
    .toLuxonInterval({ DateTime, Interval })
  Copy

  Type Parameters

  • IntervalType

  Parameters

  • __namedParameters: {
        DateTime: any;
        Interval: { fromDateTimes(start: any, end: any): IntervalType };
    }
  • Optional_now: Date

  Returns IntervalType

  A luxon interval.

  Link

  Luxon

toMomentRange

• toMomentRange<MomentType>(moment: () => MomentType, _now?: Date): MomentType

• Convert the span to a moment range.

  import * as Moment from 'moment-timezone'
  import { extendMoment } from 'moment-range'
  const moment = extendMoment(Moment)
  ...
  const range = new HSpan({ mode: SpanMode.today })
    .toMomentRange(moment)
  Copy

  Type Parameters

  • MomentType

  Parameters

  • moment: () => MomentType
  • Optional_now: Date

  Returns MomentType

  Link

  Moment with timezones

  Link

  Moment range

toString

• toString(): string

• Returns string

  Encodes the span as a string value.

StaticfromStr

• fromStr(str: string): undefined | HSpan

• Create a span from a encoded string or undefined if it can't be decoded.

  Decode from string format:

  • relative SpanMode mode name
  • absolute single date: 'YYYY-MM-DD'
  • absolute date span: 'YYYY-MM-DD,YYYY-MM-DD'
  • absolute date time span: 'YYYY-MM-DDThh:mm:ss.FFF zzzz,YYYY-MM-DDThh:mm:ss.FFF zzzz'

  Parameters

  • str: string

    The string to decode.

  Returns undefined | HSpan

  The decoded span or undefined.