【JavaScript ECMAScript】Intl::Intl.DurationFormat.prototype.formatインスタンスメソッドの使い方

Intl.DurationFormat.prototype.format()メソッドは、期間を表す数値を、指定されたロケールや書式設定オプションに基づいて、人間が読みやすい文字列に整形して返すメソッドです。このメソッドは、事前に作成されたIntl.DurationFormatオブジェクトのインスタンスに対して呼び出されます。

引数としては、年、月、日、時間、分、秒、ミリ秒などの時間単位と、それに対応する数値をプロパティとして持つオブジェクト（DurationLikeオブジェクト）を受け取ります。例えば、{ hours: 1, minutes: 30 } のような形式です。メソッドは、このオブジェクトの各プロパティの値を参照し、Intl.DurationFormatオブジェクトが初期化された際に指定されたロケール（例えば日本語や英語）や書式（例えば「short」や「long」）に従って、期間を表す文字列を生成します。

生成される文字列は、各ロケールに適した表現となるため、開発者が手動で多言語対応の期間表示を実装する手間を大幅に削減できます。例えば、日本語ロケールであれば「1時間30分」と、英語ロケールであれば「1 hour 30 minutes」のように、言語や地域の慣習に合わせた適切な形式で出力されます。これにより、国際化されたウェブアプリケーションなどで、ユーザーに分かりやすい期間情報を提供することが可能になります。

Copy
1const durationFormat = new Intl.DurationFormat('en', { style: 'long' });
2const formatted = durationFormat.format({ hours: 1, minutes: 30 });

duration

• duration: Intl.DurationFormatOptions: フォーマットする期間のオプションを指定するオブジェクト

string

指定された期間のフォーマットされた文字列を返します。