Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【JavaScript ECMAScript】Temporal::Temporal.PlainDateTime.prototype.subtractインスタンスメソッドの使い方

Temporal.PlainDateTime.prototype.subtract()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

Temporal.PlainDateTime.prototype.subtract()メソッドは、Temporal.PlainDateTimeオブジェクトから指定された期間を減算し、その結果として新しいTemporal.PlainDateTimeオブジェクトを生成するメソッドです。このメソッドは、タイムゾーン情報や夏時間(DST)の影響を受けない純粋なカレンダー上の日付と時刻の値を扱います。具体的には、既存のPlainDateTimeインスタンスが表す日付と時刻から、年、月、日、時、分、秒、ミリ秒などの単位で定義された期間を遡った新しい日付と時刻を計算します。

このメソッドの重要な特徴は、元のPlainDateTimeオブジェクトが変更されない、つまりイミュータブルである点です。subtract()メソッドを呼び出すと、常に新しいPlainDateTimeオブジェクトが返されるため、元のオブジェクトのデータ整合性を保ちながら安全に日付と時刻の計算を進めることができます。減算する期間は、Temporal.Durationオブジェクト、あるいは期間を表すプロパティを持つプレーンなオブジェクト(DurationLikeオブジェクト)として指定可能です。例えば、ある特定の日付から1ヶ月前や3日前、または数時間前の時刻を求めたい場合に非常に有用です。カレンダー上の複雑な減算ルール(月の最終日からの減算やうるう年など)も適切に処理されるため、開発者は日付と時刻の計算ロジックに悩むことなく、堅牢なアプリケーションを構築できます。この機能は、システムのイベント発生時刻の遡及計算や、データの期間分析など、多様なシーンで活用されます。

構文(syntax)

1const plainDateTime = Temporal.PlainDateTime.from('2023-10-26T10:00:00');
2plainDateTime.subtract({ hours: 1, minutes: 30 });

引数(parameters)

durationLike

  • durationLike: 減算する期間を指定します。Temporal.Duration オブジェクト、または年、月、週、日、時間、分、秒、ミリ秒、マイクロ秒、ナノ秒を表す整数値のプロパティを持つオブジェクトを指定できます。

戻り値(return)

Temporal.PlainDateTime

Temporal.PlainDateTime.prototype.subtract() メソッドは、指定された時間間隔を元の Temporal.PlainDateTime オブジェクトから減算した新しい Temporal.PlainDateTime オブジェクトを返します。

関連コンテンツ

関連プログラミング言語