【JavaScript ECMAScript】String::String.prototype.padStartインスタンスメソッドの使い方
String.prototype.padStart()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
String.prototype.padStart()メソッドは、文字列の先頭を指定した文字列で埋めて、指定した長さに調整した新しい文字列を生成するメソッドです。このメソッドは、呼び出し元の文字列インスタンスに対して使用され、文字列の整形や表示の統一に利用されます。
第一引数targetLengthは、結果として得たい文字列全体の目標の長さを数値で指定します。もしこの指定された長さが、元の文字列の長さよりも短いか同じである場合、文字列はそのまま変更されずに返されます。
第二引数padStringはオプションで、文字列の先頭を埋めるために使用する文字列を指定します。このpadStringが省略された場合や空文字列が指定された場合は、デフォルトで半角スペース( )が使用されます。もしpadStringがtargetLengthに達するまでに複数回繰り返して使用される必要がある場合、その文字列は必要に応じて切り詰められます。
padStart()メソッドは、元の文字列を変更せず、常に新しい文字列を返します。この機能は、例えば、日付や時刻の表示で「1月」を「01月」のように2桁で揃えたり、商品コードや会員番号などの連番で「1」を「001」のように桁数を揃えたりする際に非常に便利です。これにより、アプリケーションの出力結果の見た目を統一し、視認性や可読性を向上させることができます。
公式リファレンス: String.prototype.padStart()
構文(syntax)
1"abc".padStart(5, "*");
引数(parameters)
targetLength, padString = ' '
- targetLength: number: 埋め込み後の文字列の全長
- padString: string = ' ': 埋め込みに使用する文字列
戻り値(return)
String
指定された文字列の先頭に、指定された文字を指定された長さになるまで追加した新しい文字列を返します。