docs-devsite/firestore_.timestamp.md
Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference
{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}
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<!-- -->.
<b>Signature:</b>
export declare class Timestamp
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(seconds, nanoseconds) | Creates a new timestamp. |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| 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. |
| Method | Modifiers | Description |
|---|---|---|
| fromDate(date) | <code>static</code> | Creates a new timestamp from the given date. |
| fromJSON(json) | <code>static</code> | Builds a <code>Timestamp</code> instance from a JSON object created by Timestamp.toJSON()<!-- -->. |
| fromMillis(milliseconds) | <code>static</code> | Creates a new timestamp from the given number of milliseconds. |
| isEqual(other) | Returns true if this <code>Timestamp</code> is equal to the provided one. | |
| now() | <code>static</code> | Creates a new timestamp with the current date, with millisecond precision. |
| toDate() | Converts a <code>Timestamp</code> to a JavaScript <code>Date</code> object. This conversion causes a loss of precision since <code>Date</code> objects only support millisecond precision. | |
| toJSON() | Returns a JSON-serializable representation of this <code>Timestamp</code>. | |
| toMillis() | Converts a <code>Timestamp</code> to a numeric timestamp (in milliseconds since epoch). This operation causes a loss of precision. | |
| toString() | Returns a textual representation of this <code>Timestamp</code>. | |
| valueOf() | Converts this object to a primitive string, which allows <code>Timestamp</code> objects to be compared using the <code>></code>, <code><=</code>, <code>>=</code> and <code>></code> operators. |
Creates a new timestamp.
<b>Signature:</b>
constructor(
seconds: number,
nanoseconds: number);
| Parameter | Type | Description |
|---|---|---|
| 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. |
The fractions of a second at nanosecond resolution.*
<b>Signature:</b>
readonly nanoseconds: number;
The number of seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z.
<b>Signature:</b>
readonly seconds: number;
Creates a new timestamp from the given date.
<b>Signature:</b>
static fromDate(date: Date): Timestamp;
| Parameter | Type | Description |
|---|---|---|
| date | Date | The date to initialize the <code>Timestamp</code> from. |
<b>Returns:</b>
A new Timestamp representing the same point in time as the given date.
Builds a Timestamp instance from a JSON object created by Timestamp.toJSON()<!-- -->.
<b>Signature:</b>
static fromJSON(json: object): Timestamp;
| Parameter | Type | Description |
|---|---|---|
| json | object |
<b>Returns:</b>
Creates a new timestamp from the given number of milliseconds.
<b>Signature:</b>
static fromMillis(milliseconds: number): Timestamp;
| Parameter | Type | Description |
|---|---|---|
| milliseconds | number | Number of milliseconds since Unix epoch 1970-01-01T00:00:00Z. |
<b>Returns:</b>
A new Timestamp representing the same point in time as the given number of milliseconds.
Returns true if this Timestamp is equal to the provided one.
<b>Signature:</b>
isEqual(other: Timestamp): boolean;
| Parameter | Type | Description |
|---|---|---|
| other | Timestamp | The <code>Timestamp</code> to compare against. |
<b>Returns:</b>
boolean
true if this Timestamp is equal to the provided one.
Creates a new timestamp with the current date, with millisecond precision.
<b>Signature:</b>
static now(): Timestamp;
<b>Returns:</b>
a new timestamp representing the current date.
Converts a Timestamp to a JavaScript Date object. This conversion causes a loss of precision since Date objects only support millisecond precision.
<b>Signature:</b>
toDate(): Date;
<b>Returns:</b>
Date
JavaScript Date object representing the same point in time as this Timestamp<!-- -->, with millisecond precision.
Returns a JSON-serializable representation of this Timestamp<!-- -->.
<b>Signature:</b>
toJSON(): {
seconds: number;
nanoseconds: number;
type: string;
};
<b>Returns:</b>
{ seconds: number; nanoseconds: number; type: string; }
Converts a Timestamp to a numeric timestamp (in milliseconds since epoch). This operation causes a loss of precision.
<b>Signature:</b>
toMillis(): number;
<b>Returns:</b>
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<!-- -->.
<b>Signature:</b>
toString(): string;
<b>Returns:</b>
string
Converts this object to a primitive string, which allows Timestamp objects to be compared using the ><!-- -->, <=<!-- -->, >= and > operators.
<b>Signature:</b>
valueOf(): string;
<b>Returns:</b>
string