Skip to content

@magmacomputing/tempo


Defined in: tempo.class.ts:1552

Extends

  • BaseOptions

Properties

calendar

calendar: CalendarLike

Defined in: tempo.type.ts:153

Temporal calendar

Inherited from

t.Internal.BaseOptions.calendar


catch

catch: boolean | undefined

Defined in: tempo.type.ts:150

catch or throw Errors

Inherited from

t.Internal.BaseOptions.catch


debug

debug: number | boolean | undefined

Defined in: tempo.type.ts:149

additional console.log for tracking

Inherited from

t.Internal.BaseOptions.debug


discovery

discovery: string | symbol

Defined in: tempo.type.ts:148

globalThis Discovery Symbol

Inherited from

t.Internal.BaseOptions.discovery


event

event: Extend<{ christmas: "25 Dec"; christmas ?eve: "24 Dec"; fortnight: (this) => Tempo; new.?years? ?eve: "31 Dec"; new.?years?( ?day)?: "01 Jan"; now: (this) => ZonedDateTime; ny: "01 Jan"; nye: "31 Dec"; today: (this) => ZonedDateTime; tomorrow: (this) => Tempo; xmas: "25 Dec"; xmas ?eve: "24 Dec"; yesterday: (this) => Tempo; }, string, string | Function> | PatternOption<Logic>

Defined in: tempo.type.ts:166

custom date aliases (events).

Inherited from

t.Internal.BaseOptions.event


formats

formats: Property<any>

Defined in: tempo.type.ts:169

custom format strings to merge in the FORMAT enum

Inherited from

t.Internal.BaseOptions.formats


ignore

ignore: Ignore

Defined in: tempo.type.ts:168

noise words to ignore during parsing.

Inherited from

t.Internal.BaseOptions.ignore


layout

layout: Extend<{[key: symbol]: string; }, symbol, string> | PatternOption<Pattern>

Defined in: tempo.type.ts:165

patterns to help parse value

Inherited from

t.Internal.BaseOptions.layout


layoutOrder

layoutOrder: string[]

Defined in: tempo.type.ts:163

preferred parse-order of layouts

Inherited from

t.Internal.BaseOptions.layoutOrder


locale

locale: string

Defined in: tempo.type.ts:154

locale (e.g. en-AU)

Inherited from

t.Internal.BaseOptions.locale


mdyLayouts

mdyLayouts: Pair[]

Defined in: tempo.type.ts:162

swap parse-order of layouts

Inherited from

t.Internal.BaseOptions.mdyLayouts


mdyLocales

mdyLocales: string | string[]

Defined in: tempo.type.ts:161

locale-names that prefer 'mm-dd-yy' date order

Inherited from

t.Internal.BaseOptions.mdyLocales


mode?

optional mode?: "auto" | "strict" | "defer"

Defined in: tempo.type.ts:160

initialization strategy ('auto'|'strict'|'defer')

Inherited from

t.Internal.BaseOptions.mode


period

period: Extend<{ after[ -]?noon: "3:00pm"; evening: "18:00"; half[ -]?hour: (this) => string; mid[ -]?day: "12:00"; mid[ -]?morning: "10:00"; mid[ -]?night: "24:00"; morning: "8:00"; night: "20:00"; noon: "12:00"; }, string, string | Function> | PatternOption<Logic>

Defined in: tempo.type.ts:167

custom time aliases (periods).

Inherited from

t.Internal.BaseOptions.period


pivot

pivot: number

Defined in: tempo.type.ts:155

pivot year for two-digit years

Inherited from

t.Internal.BaseOptions.pivot


plugins

plugins: Plugin | Plugin[]

Defined in: tempo.type.ts:170

plugins to be automatically extended

Inherited from

t.Internal.BaseOptions.plugins


rtfFormat?

optional rtfFormat?: RelativeTimeFormat

Defined in: tempo.type.ts:157

Pre-configured relative time formatter

Inherited from

t.Internal.BaseOptions.rtfFormat


rtfStyle?

optional rtfStyle?: RelativeTimeFormatStyle

Defined in: tempo.type.ts:158

Default style for relative time ('long' | 'short' | 'narrow')

Inherited from

t.Internal.BaseOptions.rtfStyle


silent

silent: boolean | undefined

Defined in: tempo.type.ts:151

suppress console output during catch

Inherited from

t.Internal.BaseOptions.silent


snippet

snippet: Extend<{[key: symbol]: RegExp; }, symbol, RegExp> | PatternOption<Pattern>

Defined in: tempo.type.ts:164

date-time snippets to help compose a Layout

Inherited from

t.Internal.BaseOptions.snippet


sphere

sphere: string | undefined

Defined in: tempo.type.ts:156

hemisphere for term.qtr or term.szn

Inherited from

t.Internal.BaseOptions.sphere


store

store: string

Defined in: tempo.type.ts:147

localStorage key

Inherited from

t.Internal.BaseOptions.store


timeStamp?

optional timeStamp?: TimeStamp

Defined in: tempo.type.ts:159

Precision to measure timestamps (ms | us)

Inherited from

t.Internal.BaseOptions.timeStamp


timeZone

timeZone: TimeZoneLike

Defined in: tempo.type.ts:152

Temporal timeZone

Inherited from

t.Internal.BaseOptions.timeZone


value

value: DateTime

Defined in: tempo.type.ts:171

supplied value to parse

Inherited from

t.Internal.BaseOptions.value

Released under the MIT License.