Class Time

Hierarchy

Time

Index

Constructors

constructor

new Time(date?: TimeDate, format?: TimeFormat): Time
Parameters
- Optional date: TimeDate
- Optional format: TimeFormat
Returns Time
- Defined in packages/tools/src/time.ts:40

Properties

`Private` #date

#date: Dayjs

Accessors

ISO

get ISO(): string
Returns string
- Defined in packages/tools/src/time.ts:101

RFC3339

get RFC3339(): string
Returns string
- Defined in packages/tools/src/time.ts:105

dayjs

get dayjs(): Dayjs
Returns Dayjs
- Defined in packages/tools/src/time.ts:71

fromNow

get fromNow(): string
Returns string
- Defined in packages/tools/src/time.ts:201

isValid

get isValid(): boolean
Returns boolean
- Defined in packages/tools/src/time.ts:85

ms

get ms(): number
Returns number
- Defined in packages/tools/src/time.ts:97

timestamp

get timestamp(): number
Returns number
- Defined in packages/tools/src/time.ts:93

toNow

get toNow(): string
Returns string
- Defined in packages/tools/src/time.ts:209

Methods

`Private` _dayjs

_dayjs(date?: TimeDate, format?: TimeFormat): Dayjs
Parameters
- Optional date: TimeDate
- Optional format: TimeFormat
Returns Dayjs
- Defined in packages/tools/src/time.ts:63

`Private` _tz

_tz(date: TimeDate, timezone?: string): Dayjs
Parameters
- date: TimeDate
- Optional timezone: string
Returns Dayjs
- Defined in packages/tools/src/time.ts:67

add

add(value: number, unit?: TimeManipulate): Time
Parameters
- value: number
- Optional unit: TimeManipulate
Returns Time
- Defined in packages/tools/src/time.ts:128

clone

clone(): Time
Returns Time
- Defined in packages/tools/src/time.ts:89

diff

diff(comparisonDate: Time, unit?: TimeUnit, isTruncated?: boolean): number
Parameters
- comparisonDate: Time
- Optional unit: TimeUnit
- isTruncated: boolean = false
Returns number
- Defined in packages/tools/src/time.ts:189

format

format(format?: string): string
Parameters
- Optional format: string
Returns string
- Defined in packages/tools/src/time.ts:133

get

get(unit: TimeUnit): number
Parameters
- unit: TimeUnit
Returns number
- Defined in packages/tools/src/time.ts:109

getAsObject

getAsObject(unit: TimeUnit[]): {
    D: number;
    M: number;
    d: number;
    date: number;
    dates: number;
    day: number;
    days: number;
    h: number;
    hour: number;
    hours: number;
    m: number;
    millisecond: number;
    milliseconds: number;
    minute: number;
    minutes: number;
    month: number;
    months: number;
    ms: number;
    s: number;
    second: number;
    seconds: number;
    y: number;
    year: number;
    years: number;
}
Parameters
- unit: TimeUnit[]
Returns {
    D: number;
    M: number;
    d: number;
    date: number;
    dates: number;
    day: number;
    days: number;
    h: number;
    hour: number;
    hours: number;
    m: number;
    millisecond: number;
    milliseconds: number;
    minute: number;
    minutes: number;
    month: number;
    months: number;
    ms: number;
    s: number;
    second: number;
    seconds: number;
    y: number;
    year: number;
    years: number;
}
- D: number
- M: number
- d: number
- date: number
- dates: number
- day: number
- days: number
- h: number
- hour: number
- hours: number
- m: number
- millisecond: number
- milliseconds: number
- minute: number
- minutes: number
- month: number
- months: number
- ms: number
- s: number
- second: number
- seconds: number
- y: number
- year: number
- years: number
- Defined in packages/tools/src/time.ts:113

getFrom

getFrom(date: TimeDate): string
Parameters
- date: TimeDate
Returns string
- Defined in packages/tools/src/time.ts:197

getTo

getTo(date: TimeDate): string
Parameters
- date: TimeDate
Returns string
- Defined in packages/tools/src/time.ts:205

isAfter

isAfter(comparisonDate?: TimeDate): boolean
Parameters
- Optional comparisonDate: TimeDate
Returns boolean
- Defined in packages/tools/src/time.ts:163

isBefore

isBefore(comparisonDate?: TimeDate): boolean
Parameters
- Optional comparisonDate: TimeDate
Returns boolean
- Defined in packages/tools/src/time.ts:159

isBetween

isBetween(startDate?: TimeDate, endDate?: TimeDate, unit?: TimeManipulate, inclusivity?: Inclusivity): boolean
Parameters
- Optional startDate: TimeDate
- Optional endDate: TimeDate
- Optional unit: TimeManipulate
- Optional inclusivity: Inclusivity
Returns boolean
- Defined in packages/tools/src/time.ts:175

isSame

isSame(comparisonDate?: TimeDate, unit?: TimeOpUnit): boolean
Parameters
- Optional comparisonDate: TimeDate
- Optional unit: TimeOpUnit
Returns boolean
- Defined in packages/tools/src/time.ts:155

isSameOrAfter

isSameOrAfter(comparisonDate?: TimeDate): boolean
Parameters
- Optional comparisonDate: TimeDate
Returns boolean
- Defined in packages/tools/src/time.ts:167

isSameOrBefore

isSameOrBefore(comparisonDate?: TimeDate): boolean
Parameters
- Optional comparisonDate: TimeDate
Returns boolean
- Defined in packages/tools/src/time.ts:171

startOf

startOf(unit: TimeOpUnit): Time
Parameters
- unit: TimeOpUnit
Returns Time
- Defined in packages/tools/src/time.ts:150

subtract

subtract(value: number, unit?: TimeManipulate): Time
Parameters
- value: number
- Optional unit: TimeManipulate
Returns Time
- Defined in packages/tools/src/time.ts:145

toCalendar

toCalendar(referenceTime?: TimeDate, calendar?: Partial<{
    lastDay: string;
    lastWeek: string;
    nextDay: string;
    nextWeek: string;
    sameDay: string;
    sameElse: string;
}>): string
Parameters
- Optional referenceTime: TimeDate
- Optional calendar: Partial<{
      lastDay: string;
      lastWeek: string;
      nextDay: string;
      nextWeek: string;
      sameDay: string;
      sameElse: string;
  }>
Returns string
- Defined in packages/tools/src/time.ts:141

toDate

toDate(): Date
Returns Date
- Defined in packages/tools/src/time.ts:137

tz

tz(timezone?: string): Time
Parameters
- Optional timezone: string
Returns Time
- Defined in packages/tools/src/time.ts:75

utc

utc(keepLocalTime?: boolean): Time
Parameters
- Optional keepLocalTime: boolean
Returns Time
- Defined in packages/tools/src/time.ts:80

`Static` locale

locale(preset?: string | ILocale, object?: Partial<ILocale>, isLocal?: boolean): string
Parameters
- Optional preset: string | ILocale
- Optional object: Partial<ILocale>
- Optional isLocal: boolean
Returns string
- Defined in packages/tools/src/time.ts:44

`Static` setDefaultTimezone

setDefaultTimezone(timezone?: string): void
Parameters
- Optional timezone: string
Returns void
- Defined in packages/tools/src/time.ts:52

`Static` setLocale

setLocale(localeName: string, customConfig: Partial<{
    calendar: Partial<{
        lastDay: string;
        lastWeek: string;
        nextDay: string;
        nextWeek: string;
        sameDay: string;
        sameElse: string;
    }>;
    formats: {
        L: string;
        LL: string;
        LLL: string;
        LLLL: string;
        LT: string;
        LTS: string;
        l: string;
        ll: string;
        lll: string;
        llll: string;
    };
    meridiem: ((hour?: number, minute?: number, isLowercase?: boolean) => string);
    months: string[];
    monthsShort: string[];
    name: string;
    ordinal: ((n: number) => string);
    relativeTime: {
        M: string;
        MM: string;
        d: string;
        dd: string;
        future: string;
        h: string;
        hh: string;
        m: string;
        mm: string;
        past: string;
        s: string;
        y: string;
        yy: string;
    };
    weekStart: number;
    weekdays: string[];
    weekdaysMin: string[];
    weekdaysShort: string[];
    yearStart: number;
}>): Partial<{
    calendar: Partial<{
        lastDay: string;
        lastWeek: string;
        nextDay: string;
        nextWeek: string;
        sameDay: string;
        sameElse: string;
    }>;
    formats: {
        L: string;
        LL: string;
        LLL: string;
        LLLL: string;
        LT: string;
        LTS: string;
        l: string;
        ll: string;
        lll: string;
        llll: string;
    };
    meridiem: ((hour?: number, minute?: number, isLowercase?: boolean) => string);
    months: string[];
    monthsShort: string[];
    name: string;
    ordinal: ((n: number) => string);
    relativeTime: {
        M: string;
        MM: string;
        d: string;
        dd: string;
        future: string;
        h: string;
        hh: string;
        m: string;
        mm: string;
        past: string;
        s: string;
        y: string;
        yy: string;
    };
    weekStart: number;
    weekdays: string[];
    weekdaysMin: string[];
    weekdaysShort: string[];
    yearStart: number;
}>
Parameters
- localeName: string
- customConfig: Partial<{
      calendar: Partial<{
          lastDay: string;
          lastWeek: string;
          nextDay: string;
          nextWeek: string;
          sameDay: string;
          sameElse: string;
      }>;
      formats: {
          L: string;
          LL: string;
          LLL: string;
          LLLL: string;
          LT: string;
          LTS: string;
          l: string;
          ll: string;
          lll: string;
          llll: string;
      };
      meridiem: ((hour?: number, minute?: number, isLowercase?: boolean) => string);
      months: string[];
      monthsShort: string[];
      name: string;
      ordinal: ((n: number) => string);
      relativeTime: {
          M: string;
          MM: string;
          d: string;
          dd: string;
          future: string;
          h: string;
          hh: string;
          m: string;
          mm: string;
          past: string;
          s: string;
          y: string;
          yy: string;
      };
      weekStart: number;
      weekdays: string[];
      weekdaysMin: string[];
      weekdaysShort: string[];
      yearStart: number;
  }>
Returns Partial<{
    calendar: Partial<{
        lastDay: string;
        lastWeek: string;
        nextDay: string;
        nextWeek: string;
        sameDay: string;
        sameElse: string;
    }>;
    formats: {
        L: string;
        LL: string;
        LLL: string;
        LLLL: string;
        LT: string;
        LTS: string;
        l: string;
        ll: string;
        lll: string;
        llll: string;
    };
    meridiem: ((hour?: number, minute?: number, isLowercase?: boolean) => string);
    months: string[];
    monthsShort: string[];
    name: string;
    ordinal: ((n: number) => string);
    relativeTime: {
        M: string;
        MM: string;
        d: string;
        dd: string;
        future: string;
        h: string;
        hh: string;
        m: string;
        mm: string;
        past: string;
        s: string;
        y: string;
        yy: string;
    };
    weekStart: number;
    weekdays: string[];
    weekdaysMin: string[];
    weekdaysShort: string[];
    yearStart: number;
}>
- Defined in packages/tools/src/time.ts:56

Class Time

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional date: TimeDate

Optional format: TimeFormat

Returns Time

Properties

Private #date

Accessors

ISO

Returns string

RFC3339

Returns string

dayjs

Returns Dayjs

fromNow

Returns string

isValid

Returns boolean

ms

Returns number

timestamp

Returns number

toNow

Returns string

Methods

Private _dayjs

Parameters

Optional date: TimeDate

Optional format: TimeFormat

Returns Dayjs

Private _tz

Parameters

date: TimeDate

Optional timezone: string

Returns Dayjs

add

Parameters

value: number

Optional unit: TimeManipulate

Returns Time

clone

Returns Time

diff

Parameters

comparisonDate: Time

Optional unit: TimeUnit

isTruncated: boolean = false

Returns number

format

Parameters

Optional format: string

Returns string

get

Parameters

unit: TimeUnit

Returns number

getAsObject

Parameters

unit: TimeUnit[]

D: number

M: number

d: number

date: number

dates: number

day: number

days: number

h: number

hour: number

hours: number

m: number

millisecond: number

milliseconds: number

`Optional` date: TimeDate

`Optional` format: TimeFormat

`Private` #date

`Private` _dayjs

`Optional` date: TimeDate

`Optional` format: TimeFormat

`Private` _tz

`Optional` timezone: string

`Optional` unit: TimeManipulate

`Optional` unit: TimeUnit

`Optional` format: string

`Optional` comparisonDate: TimeDate

`Optional` comparisonDate: TimeDate

`Optional` startDate: TimeDate

`Optional` endDate: TimeDate

`Optional` unit: TimeManipulate

`Optional` inclusivity: Inclusivity

`Optional` comparisonDate: TimeDate

`Optional` unit: TimeOpUnit

`Optional` comparisonDate: TimeDate

`Optional` comparisonDate: TimeDate

`Optional` unit: TimeManipulate

`Optional` referenceTime: TimeDate

`Optional` calendar: Partial<{
lastDay: string;
lastWeek: string;
nextDay: string;
nextWeek: string;
sameDay: string;
sameElse: string;
}>

`Optional` timezone: string