A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time.

It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z.

For examples and further specifications, refer to the Timestamp definition.

Hierarchy

  • Timestamp

Constructors

  • Creates a new timestamp.

    Parameters

    • seconds: number

      The number of seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

    • nanoseconds: number

      The non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanoseconds values that count forward in time. Must be from 0 to 999,999,999 inclusive.

    Returns Timestamp

Properties

nanoseconds: number

The fractions of a second at nanosecond resolution.*

seconds: number

The number of seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z.

Methods

  • Returns true if this Timestamp is equal to the provided one.

    Parameters

    • other: Timestamp

      The Timestamp to compare against.

    Returns boolean

    true if this Timestamp is equal to the provided one.

  • Converts a Timestamp to a JavaScript Date object. This conversion causes a loss of precision since Date objects only support millisecond precision.

    Returns Date

    JavaScript Date object representing the same point in time as this Timestamp, with millisecond precision.

  • Returns a JSON-serializable representation of this Timestamp.

    Returns {
        nanoseconds: number;
        seconds: number;
    }

    • nanoseconds: number
    • seconds: number
  • Converts a Timestamp to a numeric timestamp (in milliseconds since epoch). This operation causes a loss of precision.

    Returns number

    The point in time corresponding to this timestamp, represented as the number of milliseconds since Unix epoch 1970-01-01T00:00:00Z.

  • Returns a textual representation of this Timestamp.

    Returns string

  • Converts this object to a primitive string, which allows Timestamp objects to be compared using the >, <=, >= and > operators.

    Returns string

  • Creates a new timestamp from the given date.

    Parameters

    • date: Date

      The date to initialize the Timestamp from.

    Returns Timestamp

    A new Timestamp representing the same point in time as the given date.

  • Creates a new timestamp from the given number of milliseconds.

    Parameters

    • milliseconds: number

      Number of milliseconds since Unix epoch 1970-01-01T00:00:00Z.

    Returns Timestamp

    A new Timestamp representing the same point in time as the given number of milliseconds.

  • Creates a new timestamp with the current date, with millisecond precision.

    Returns Timestamp

    a new timestamp representing the current date.

Generated using TypeDoc