Timestamp class

Timestamp は、タイムゾーンやカレンダーに依存しない特定の時点を表し、UTC エポック時間のナノ秒単位の分解能で秒と小数点以下で表されます。

Timestamp は先発グレゴリオ暦を使用してエンコードされています。先発グレゴリオ暦は、紀元 1 年までグレゴリオ暦を拡大したものです。このエンコーディングでは、すべての分の長さが 60 秒であると仮定されています。つまり、うるう秒を無視することで、解釈にうるう秒テーブルが不要となっています。範囲は 0001-01-01T00:00:00Z ~ 9999-12-31T23:59:59.999999999Z です。

例と詳細な仕様については、タイムスタンプの定義をご覧ください。

署名:

export declare class Timestamp 

コンストラクタ

コンストラクタ 修飾キー 説明
(コンストラクタ)(秒, ナノ秒) 新しいタイムスタンプを作成します。

プロパティ

プロパティ 修飾キー タイプ 説明
ナノ秒 数値 ナノ秒単位の分解能の 1 秒未満*。
数値 Unix エポック 1970-01-01T00:00:00Z からの UTC 時間の秒数。

メソッド

メソッド 修飾キー 説明
fromDate(date) static 指定された日付から新しいタイムスタンプを作成します。
fromMillis(milliseconds) static 指定されたミリ秒数から新しいタイムスタンプを作成します。
isEqual(other) この Timestamp が指定された値と等しい場合、true を返します。
now() static 現在の日付で新しいタイムスタンプをミリ秒単位の精度で作成します。
toDate() Timestamp を JavaScript の Date オブジェクトに変換します。Date オブジェクトはミリ秒単位の精度しかサポートしないため、この変換により精度が低下します。
toJSON() この Timestamp の JSON シリアル化可能な表現を返します。
toMillis() Timestamp を数値のタイムスタンプ(エポックからのミリ秒数)に変換します。このオペレーションでは精度が低下します。
toString() この Timestamp のテキスト表現を返します。
valueOf() このオブジェクトをプリミティブ文字列に変換します。これにより、><=>=> 演算子を使用して Timestamp オブジェクトを比較できます。

Timestamp.(コンストラクタ)

新しいタイムスタンプを作成します。

署名:

constructor(
    seconds: number, 
    nanoseconds: number);

パラメータ

パラメータ 説明
数値 Unix エポック 1970-01-01T00:00:00Z からの UTC 時間の秒数。0001-01-01T00:00:00Z ~ 9999-12-31T23:59:59Z の範囲(両端を含む)にする必要があります。
ナノ秒 数値 ナノ秒の解像度での非負の小数点以下の秒数。小数を含む負の秒の値は、時間を前方カウントする負でないナノ秒値である必要があります。0~999,999,999 の範囲(境界を含む)になります。

Timestamp.ナノ秒

ナノ秒単位の分解能の 1 秒未満*。

署名:

readonly nanoseconds: number;

Timestamp.seconds

Unix エポック 1970-01-01T00:00:00Z からの UTC 時間の秒数。

署名:

readonly seconds: number;

Timestamp.fromDate()

指定された日付から新しいタイムスタンプを作成します。

署名:

static fromDate(date: Date): Timestamp;

パラメータ

パラメータ 説明
日付 日付 Timestamp の初期化を行う日付です。

戻り値:

タイムスタンプ

指定された日付と同じ時点を表す新しい Timestamp

Timestamp.fromMillis()

指定されたミリ秒数から新しいタイムスタンプを作成します。

署名:

static fromMillis(milliseconds: number): Timestamp;

パラメータ

パラメータ 説明
ミリ秒 数値 Unix エポック 1970-01-01T00:00:00Z からの経過ミリ秒数。

戻り値:

タイムスタンプ

指定されたミリ秒数と同じ時点を表す新しい Timestamp

Timestamp.isEqual()

この Timestamp が指定された値と等しい場合、true を返します。

署名:

isEqual(other: Timestamp): boolean;

パラメータ

パラメータ 説明
その他 タイムスタンプ 比較対象の Timestamp

戻り値:

ブール値

この Timestamp が指定された値と等しい場合は true を返します。

Timestamp.now()

現在の日付で新しいタイムスタンプをミリ秒単位の精度で作成します。

署名:

static now(): Timestamp;

戻り値:

タイムスタンプ

現在の日付を表す新しいタイムスタンプ。

Timestamp.toDate()

Timestamp を JavaScript の Date オブジェクトに変換します。Date オブジェクトはミリ秒単位の精度しかサポートしないため、この変換により精度が低下します。

署名:

toDate(): Date;

戻り値:

日付

この Timestamp と同じ時点をミリ秒単位の精度で表す JavaScript Date オブジェクト。

Timestamp.toJSON()

この Timestamp の JSON シリアル化可能な表現を返します。

署名:

toJSON(): {
        seconds: number;
        nanoseconds: number;
    };

戻り値:

{ 秒: 数値;ナノ秒: 数値;}

Timestamp.toMillis()

Timestamp を数値のタイムスタンプ(エポックからのミリ秒数)に変換します。このオペレーションでは精度が低下します。

署名:

toMillis(): number;

戻り値:

数値

このタイムスタンプに対応する時点。Unix エポック 1970-01-01T00:00:00Z からの経過ミリ秒数で表されます。

Timestamp.toString()

この Timestamp のテキスト表現を返します。

署名:

toString(): string;

戻り値:

文字列

Timestamp.valueOf()

このオブジェクトをプリミティブ文字列に変換します。これにより、><=>=> 演算子を使用して Timestamp オブジェクトを比較できます。

署名:

valueOf(): string;

戻り値:

文字列