Interface Duration

A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years.

Hierarchy

  • Number
    • Duration

Methods

Abs Hours Microseconds Milliseconds Minutes Nanoseconds Round Seconds String Truncate toExponential toFixed toLocaleString toPrecision toString valueOf

Methods

Abs

  • Abs returns the absolute value of d. As a special case, [math.MinInt64] is converted to [math.MaxInt64].

    Returns Duration

Hours

  • Hours returns the duration as a floating point number of hours.

    Returns number

Microseconds

  • Microseconds returns the duration as an integer microsecond count.

    Returns number

Milliseconds

  • Milliseconds returns the duration as an integer millisecond count.

    Returns number

Minutes

  • Minutes returns the duration as a floating point number of minutes.

    Returns number

Nanoseconds

  • Nanoseconds returns the duration as an integer nanosecond count.

    Returns number

Round

  • Round returns the result of rounding d to the nearest multiple of m. The rounding behavior for halfway values is to round away from zero. If the result exceeds the maximum (or minimum) value that can be stored in a [Duration], Round returns the maximum (or minimum) duration. If m <= 0, Round returns d unchanged.

    Parameters

    Returns Duration

Seconds

  • Seconds returns the duration as a floating point number of seconds.

    Returns number

String

  • String returns a string representing the duration in the form "72h3m0.5s". Leading zero units are omitted. As a special case, durations less than one second format use a smaller unit (milli-, micro-, or nanoseconds) to ensure that the leading digit is non-zero. The zero duration formats as 0s.

    Returns string

Truncate

  • Truncate returns the result of rounding d toward zero to a multiple of m. If m <= 0, Truncate returns d unchanged.

    Parameters

    Returns Duration

toExponential

  • Returns a string containing a number represented in exponential notation.

    Parameters

    • Optional fractionDigits: number

      Number of digits after the decimal point. Must be in the range 0 - 20, inclusive.

    Returns string

toFixed

  • Returns a string representing a number in fixed-point notation.

    Parameters

    • Optional fractionDigits: number

      Number of digits after the decimal point. Must be in the range 0 - 20, inclusive.

    Returns string

toLocaleString

  • Converts a number to a string by using the current or specified locale.

    Parameters

    • Optional locales: string | string[]

      A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used.

    • Optional options: NumberFormatOptions

      An object that contains one or more properties that specify comparison options.

    Returns string

toPrecision

  • Returns a string containing a number represented either in exponential or fixed-point notation with a specified number of digits.

    Parameters

    • Optional precision: number

      Number of significant digits. Must be in the range 1 - 21, inclusive.

    Returns string

toString

  • Returns a string representation of an object.

    Parameters

    • Optional radix: number

      Specifies a radix for converting numeric values to strings. This value is only used for numbers.

    Returns string

valueOf

  • Returns the primitive value of the specified object.

    Returns number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc