Skip to main content

Class: Duration

Defined in: bee-js/src/utils/duration.ts:3

Properties​

ZERO​

static ZERO: Duration

Defined in: bee-js/src/utils/duration.ts:5

Methods​

isZero()​

isZero(): boolean

Defined in: bee-js/src/utils/duration.ts:98

Returns​

boolean

represent()​

represent(): string

Defined in: bee-js/src/utils/duration.ts:94

Returns​

string

toDays()​

toDays(): number

Defined in: bee-js/src/utils/duration.ts:78

Returns​

number

toEndDate()​

toEndDate(startDate?): Date

Defined in: bee-js/src/utils/duration.ts:90

Parameters​

startDate?​

Date

Returns​

Date

toHours()​

toHours(): number

Defined in: bee-js/src/utils/duration.ts:74

Returns​

number

toSeconds()​

toSeconds(): number

Defined in: bee-js/src/utils/duration.ts:70

Returns​

number

toWeeks()​

toWeeks(): number

Defined in: bee-js/src/utils/duration.ts:82

Returns​

number

toYears()​

toYears(): number

Defined in: bee-js/src/utils/duration.ts:86

Returns​

number

fromDays()​

static fromDays(days): Duration

Defined in: bee-js/src/utils/duration.ts:27

Parameters​

days​

number

Returns​

Duration

fromEndDate()​

static fromEndDate(endDate, startDate?): Duration

Defined in: bee-js/src/utils/duration.ts:39

Parameters​

endDate​

Date

startDate?​

Date

Returns​

Duration

fromHours()​

static fromHours(hours): Duration

Defined in: bee-js/src/utils/duration.ts:23

Parameters​

hours​

number

Returns​

Duration

fromMilliseconds()​

static fromMilliseconds(milliseconds): Duration

Defined in: bee-js/src/utils/duration.ts:15

Parameters​

milliseconds​

number

Returns​

Duration

fromSeconds()​

static fromSeconds(seconds): Duration

Defined in: bee-js/src/utils/duration.ts:19

Parameters​

seconds​

number

Returns​

Duration

fromWeeks()​

static fromWeeks(weeks): Duration

Defined in: bee-js/src/utils/duration.ts:31

Parameters​

weeks​

number

Returns​

Duration

fromYears()​

static fromYears(years): Duration

Defined in: bee-js/src/utils/duration.ts:35

Parameters​

years​

number

Returns​

Duration

parseFromString()​

static parseFromString(duration): Duration

Defined in: bee-js/src/utils/duration.ts:66

Parses a duration string and returns a Duration instance.

Case insensitive. E.g. both "28h" and "1D" are valid.

Whitespaces are ignored. E.g. both "5 d" and "2weeks" are valid.

Decimal numbers are supported. E.g. "1.5h" is valid.

Supported units:

  • ms, milli, millis, millisecond, milliseconds
  • s, sec, second, seconds
  • m, min, minute, minutes
  • h, hour, hours
  • d, day, days
  • w, week, weeks
  • month, months
  • y, year, years

Parameters​

duration​

string

A string representing a duration

Returns​

Duration

a Duration instance

💬 Get Help