@haxall/haxall
    Preparing search index...

    Class Span

    Span models a range of time using an inclusive starting timestamp and exclusive ending timestamp.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:

      this < that   =>  <0
      this == that => 0
      this > that => >0

      This method may also be accessed via the < <= <=> >= and > shortcut operators. If not overridden the default implementation compares the toStr representations. Also see docLang.

      Examples:

      3.compare(8)  =>  -1
      8.compare(3) => 1
      8.compare(8) => 0
      3 <=> 8 => -1 // shortcut for 3.compare(8)

      Parameters

      Returns number

    • Display string for current locale

      Returns string

    • Exclusive ending timestamp

      Returns DateTime

    • Equality is based on mode only for relative, start/end for abs

      Parameters

      Returns boolean

    • Hash code is based on mode only for relative, start/end for abs

      Returns number

    • Return if this Obj is immutable and safe to share between threads:

      • an instance of a const class
      • the result of toImmutable on List, Map, or Buf
      • a Func object may or may not be immutable - see sys::Func.
      • other instances are assumed mutable and return false

      Returns boolean

    • Absolute or relative mode

      Returns SpanMode

    • Inclusive starting timestamp

      Returns DateTime

    • Return axon representation for this span.

      Returns string

    • Convert this span to a DateSpan attempting to use aligned dates

      Returns DateSpan

    • Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:

      • if type is const, return this
      • if already an immutable List, Map, Buf, or Func return this
      • if a List, then attempt to perform a deep clone by calling toImmutable on all items
      • if a Map, then attempt to perform a deep clone by calling toImmutable on all values (keys are already immutable)
      • some Funcs can be made immutable - see sys::Func
      • if a Buf create immutable copy, see sys::Buf
      • any other object throws NotImmutableErr

      Returns Readonly<this>

    • Encode to string, see fromStr

      Returns string

    • Trap a dynamic call for handling. Dynamic calls are invoked with the -> shortcut operator:

      a->x        a.trap("x", null)
      a->x() a.trap("x", null)
      a->x = b a.trap("x", [b])
      a->x(b) a.trap("x", [b])
      a->x(b, c) a.trap("x", [b, c])

      The default implementation provided by Obj attempts to use reflection. If name maps to a method, it is invoked with the specified arguments. If name maps to a field and args.size is zero, get the field. If name maps to a field and args.size is one, set the field and return args[0]. Otherwise throw UnknownSlotErr.

      Parameters

      Returns JsObj

    • Get the Type instance which represents this object's class. Also seeType.of or Pod.of.

      Returns Type

    • Timezone for this span

      Returns TimeZone

    • This method called whenever an it-block is applied to an object. The default implementation calls the function with this, and then returns this.

      Parameters

      • f: (arg0: this) => void

      Returns this

    • Write x.toStr to standard output followed by newline. If x is null then print "null". If no argument is provided then print an empty line.

      Parameters

      Returns void

    • 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
      • Optionaltz: TimeZone
      • Optionalchecked: boolean
      • ...args: unknown[]

      Returns Span

    • Make an absolute span for two date times which must be defined in the Rel timezone

      Parameters

      Returns Span

    • Make an absolute span for the given date

      Parameters

      Returns Span

    • Make a relative span for given mode using current time and current locale for starting weekday

      Parameters

      Returns Span

    • Convenience for Span(SpanMode.today)

      Parameters

      Returns Span