Class Timestamp (4.9.8)

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.

https://github.com/google/protobuf/blob/master/src/google/protobuf/timestamp.proto

Package

@google-cloud/firestore!

Constructors

(constructor)(seconds, nanoseconds)

constructor(seconds: number, nanoseconds: number);

Creates a new timestamp.

Parameters
NameDescription
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.

Properties

nanoseconds

get nanoseconds(): number;

The non-negative fractions of a second at nanosecond resolution.

Property Value
TypeDescription
number

seconds

get seconds(): number;

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

Property Value
TypeDescription
number

Methods

fromDate(date)

static fromDate(date: Date): Timestamp;

Creates a new timestamp from the given date.

Parameter
NameDescription
date Date

The date to initialize the Timestamp from. {Timestamp} A new Timestamp representing the same point in time as the given date.

Returns
TypeDescription
Timestamp

fromMillis(milliseconds)

static fromMillis(milliseconds: number): Timestamp;

Creates a new timestamp from the given number of milliseconds.

Parameter
NameDescription
milliseconds number

Number of milliseconds since Unix epoch 1970-01-01T00:00:00Z. {Timestamp} A new Timestamp representing the same point in time as the given number of milliseconds.

Returns
TypeDescription
Timestamp

fromProto(timestamp)

static fromProto(timestamp: google.protobuf.ITimestamp): Timestamp;

Generates a Timestamp object from a Timestamp proto.

Parameter
NameDescription
timestamp google.protobuf.ITimestamp

The Timestamp Protobuf object.

Returns
TypeDescription
Timestamp

isEqual(other)

isEqual(other: firestore.Timestamp): boolean;

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

Parameter
NameDescription
other firestore.Timestamp

The Timestamp to compare against. {boolean} 'true' if this Timestamp is equal to the provided one.

Returns
TypeDescription
boolean

now()

static now(): Timestamp;

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

Returns
TypeDescription
Timestamp

toDate()

toDate(): Date;

Returns a new Date corresponding to this timestamp. This may lose precision.

Returns
TypeDescription
Date

toMillis()

toMillis(): number;

Returns the number of milliseconds since Unix epoch 1970-01-01T00:00:00Z.

Returns
TypeDescription
number

toProto()

toProto(): api.IValue;

Generates the Protobuf Timestamp object for this timestamp.

Returns
TypeDescription
api.IValue

{Object} The Timestamp Protobuf object.

valueOf()

valueOf(): string;

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

{string} a string encoding of this object.

Returns
TypeDescription
string