JavaScript/String/prototype/padEnd

String.prototype.padEnd() は、文字列が指定した長さになるまで末尾に指定した文字列を追加するメソッドです。このメソッドは、文字列を整形したり、特定の長さに調整したりするために使用されます。

構文

str.padEnd(maxLength [, fillString])

• maxLength: 結果の文字列の長さ。元の文字列の長さよりも小さい場合は、元の文字列がそのまま返されます。
• fillString: 埋め込みに使用する文字列。省略した場合は空白文字（" "）が使用されます。

例

基本的な使用法

以下のプログラムは、String.prototype.padEnd() を使用して文字列を指定した長さに調整します。

const str = 'abc';

console.log(str.padEnd(10));      // "abc       "
console.log(str.padEnd(10, '.'));  // "abc......."
console.log(str.padEnd(5, '123')); // "abc12"
console.log(str.padEnd(3));        // "abc"（変更なし）

このプログラムでは、文字列 "abc" を異なる長さと埋め込み文字列でパディングした結果を示しています。

表形式のデータ整形

以下のプログラムは、表形式のデータを整形するために padEnd() を使用する例です。

const fruits = ['Apple', 'Banana', 'Orange', 'Strawberry'];
const prices = [100, 200, 150, 250];

// 表形式で商品と価格を表示
for (const [index, fruit] of fruits.entries()) {
  console.log(`${fruit.padEnd(15)}${prices[index]} 円`); 
}
// 出力:
// Apple          100 円
// Banana         200 円
// Orange         150 円
// Strawberry     250 円
// 000000000011111111112
// 012345678901234567890

このプログラムでは、各果物の名前を同じ幅に調整して表形式で表示するために padEnd() を使用しています。これにより、価格が綺麗に整列されます。

複数文字の埋め込み

以下のプログラムは、複数文字の埋め込み文字列を使用した場合の動作を示します。

const str = 'hello';

console.log(str.padEnd(10, '123')); // "hello12312"
console.log(str.padEnd(6, '123'));  // "hello1"
console.log(str.padEnd(9, '-='));   // "hello-=-="

このプログラムでは、複数文字の埋め込み文字列が必要に応じて繰り返されたり、切り捨てられたりする様子を示しています。

注意点

• 元の文字列への影響: padEnd() メソッドは元の文字列を変更せず、新しい文字列を返します。
• maxLength: 指定した maxLength が元の文字列の長さ以下の場合、元の文字列がそのまま返されます。
• fillString: fillString が複数の文字を含む場合、必要な長さを満たすために繰り返し使用されますが、結果の文字列が maxLength を超えないように切り捨てられます。
• 空の文字列: fillString が空の文字列 (`""`) の場合、元の文字列がそのまま返されます。

外部リンク

• ECMA-262::22.1.3.16 String.prototype.padEnd ( maxLength [ , fillString )]