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

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

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

作成日: 更新日:

基本的な使い方

Intl.ListFormat.prototype.format()メソッドは、複数の文字列要素からなるリストを、特定のロケール(言語や地域)に応じた自然な言語表現で一つの文字列に整形して返すメソッドです。

このメソッドは、JavaScriptの国際化API(Intlオブジェクト)の一部であるIntl.ListFormatオブジェクトのインスタンスに属します。利用する際は、まずnew Intl.ListFormat()コンストラクタを用いて、リストの整形方法を定義するインスタンスを作成します。このインスタンス作成時には、対象となるロケール(例: 'en-US'や'ja-JP')、リストのスタイル(例: "long"、"short"、"narrow")、そしてリスト要素間の関係を示すタイプ(例: "conjunction"(「と」「および」)、"disjunction"(「または」)、"unit"(単位のリスト))を指定することができます。

具体的には、format()メソッドは引数として文字列の配列を受け取ります。そして、その配列の各要素を、事前に設定されたロケールやスタイル、タイプに基づいて、適切に連結された一つの読みやすい文字列として出力します。例えば、英語ロケールとconjunctionタイプが設定されていれば、["apple", "banana", "orange"]は「"apple, banana, and orange"」と整形され、日本語ロケールであれば「"apple、banana、orange"」のように整形されます。

この機能は、多言語対応(国際化、i18n)が必要なウェブアプリケーションやシステムにおいて、様々な言語環境でリスト形式の情報をユーザーに自然な形で提示するために非常に重要です。開発者は、言語ごとのリストの表現規則を個別に実装することなく、このメソッドを利用することで効率的に国際化対応を進めることができます。

公式リファレンス: Intl.ListFormat.prototype.format()

構文(syntax)

1const listFormatter = new Intl.ListFormat('en', { style: 'long', type: 'conjunction' });
2const items = ['apple', 'banana', 'cherry'];
3const formattedItems = listFormatter.format(items);

引数(parameters)

list

  • list: string[]: フォーマットする文字列の配列

戻り値(return)

string

配列の要素を、言語の慣習に従った形式で結合した文字列を返します。

関連コンテンツ

関連プログラミング言語