@haxall/haxall
    Preparing search index...

    Class Month

    Enum for twelve months of the year.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Compare based on ordinal value.

      Parameters

      Returns number

    • Return the month before this month.

      Returns Month

    • Enums are only equal if same instance using ===.

      Parameters

      Returns boolean

    • Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.

      Returns number

    • Return the month after this month.

      Returns Month

    • 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

    • Get the abbreviated name for the current locale. Configured by the sys::<name>Abbr localized property.

      Returns string

    • Get the full name for the current locale. Configured by the sys::<name>Full localized property.

      Returns string

    • Get the programatic name for this enum.

      Returns string

    • Return the number of days in this month for the specified year.

      Parameters

      • year: number

      Returns number

    • Return ordinal value which is a zero based index into values.

      Returns number

    • 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>

    • Return the month as a localized string according to the specified pattern. The pattern rules are a subset of the DateTime.toLocale:

      M      One/two digit month        6, 11
      MM Two digit month 06, 11
      MMM Three letter abbr month Jun, Nov
      MMMM Full month name June, November

      If pattern is null it defaults to "MMM". Also see localeAbbr and localeFull.

      Parameters

      • Optionalpattern: string
      • Optionallocale: Locale

      Returns string

    • Always returns name().

      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

    • 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

    • April

      Returns Month

    • August

      Returns Month

    • December

      Returns Month

    • 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

    • February

      Returns Month

    • Return the Month instance for the specified name. If not a valid name and checked is false return null, otherwise throw ParseErr.

      Parameters

      • name: string
      • Optionalchecked: boolean
      • ...args: unknown[]

      Returns Month

    • January

      Returns Month

    • July

      Returns Month

    • June

      Returns Month

    • March

      Returns Month

    • May

      Returns Month

    • November

      Returns Month

    • October

      Returns Month

    • September

      Returns Month

    • List of Month values indexed by ordinal

      Returns List<Month>