【JavaScript ECMAScript】String::String.prototype.padEndインスタンスメソッドの使い方
String.prototype.padEnd()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
String.prototype.padEnd()メソッドは、現在の文字列の末尾に、指定された長さになるまで特定の文字列(パディング文字列)を埋め込むことで、新しい文字列を生成して返すメソッドです。
このメソッドの主な目的は、文字列の長さを指定された目標の長さに揃えることです。もし現在の文字列の長さが、目標の長さ(targetLength)以上である場合、元の文字列は変更されずにそのまま返されます。
引数には二つあります。一つ目は必須のtargetLengthで、これは最終的に得られる文字列の目標の長さを数値で指定します。二つ目はオプションのpadStringで、これは末尾に埋め込む文字列を指定します。padStringが省略された場合、デフォルトで半角スペースが使用されます。また、padStringがtargetLengthから現在の文字列の長さを引いた値よりも短い場合、padStringは繰り返して使用され、指定された長さに達するまで埋め込まれます。
例えば、数値の表示で桁数を揃えたい場合や、固定長のデータ形式を扱う場合などに活用できます。このメソッドは元の文字列を変更するのではなく、常に新しい文字列を返すため、元の文字列は安全に保持されます。これにより、データの整形や表示の統一性を保つ際に非常に役立ちます。
公式リファレンス: String.prototype.padEnd()
構文(syntax)
1const originalString = "Hello"; 2const paddedString = originalString.padEnd(10, "."); 3console.log(paddedString);
引数(parameters)
targetLength, padString = ' '
- targetLength: number: パディング後の文字列の全長を指定する数値
- padString: string = ' ': パディングに使用する文字列。指定しない場合はスペースが使用されます。
戻り値(return)
String
指定された文字列の末尾に、指定された文字を指定された長さになるまで追加した新しい文字列を返します。