JavaScriptで文字列の先頭を指定した長さになるように文字埋めするpadStart
メソッドについて解説します。
padStart
メソッドを使うと、文字列の先頭に指定した文字列を繰り返し追加して、文字列を指定した長さにすることができます。
数値の0埋めや、文字列の長さを揃えたい場合、特定の形式で文字列を整形したい場合に便利です。
padStartメソッドの基本的な使い方
padStart
メソッドは、文字列の先頭を指定した長さになるように文字埋めし、新しい文字列を返します。
基本的な構文は以下のとおりです。
string.padStart(targetLength, padString)
targetLength
: 結果の文字列の長さ(必須)。- 0以上の整数値を指定します。
- 現在の文字列の長さより小さい値を指定した場合、現在の文字列がそのまま返されます。
padString
: 埋める文字列(省略可能)。- 省略した場合、空白文字で埋められます。
- 埋める文字列が長すぎる場合、指定された長さに収まるように切り捨てられます。
数値の0埋め
数値を0埋めしてみます。
const number = 123;
const paddedNumber = String(number).padStart(5, '0');
console.log(paddedNumber); // 結果:00123
最初にnumber
変数に数値の123
を代入しています。
そして数値123
を文字列に変換し、padStart
メソッドを呼び出しています。
第1引数に文字列の全体の長さで「5
」、第2引数に埋めたい文字の「0
」を指定しました。
これで、先頭に「0
」を繰り返し追加して、文字列の長さを「5
」にしています。
結果「00123
」になりました。
文字列の先頭を文字埋めする
文字列の先頭を指定した文字で埋めてみます。
const str = 'abc';
console.log(str.padStart(5, '-')); // 結果:--abc
console.log(str.padStart(8, '*')); // 結果:*****abc
str
文字列の先頭をpadStart
メソッドで文字埋めしています。
1つ目の例では、str
文字列の先頭に’-‘を繰り返し追加して、文字列の長さを5
にしています。
2つ目の例では、str
文字列の先頭に’*’を繰り返し追加して、文字列の長さを8
にしています。
それぞれ、文字列が先頭に指定した文字で埋まることが確認できました。
埋める文字列を省略する
padStart
メソッドの第2引数padString
を省略すると、空白文字で埋められます。
const str = 'abc';
console.log('test' + str.padStart(5)); // 結果:test abc
文字列を入れたstr
変数からpadStart
メソッドを使って、先頭の文字を空白文字で埋めました。
コンソールログにtest
という文字列と一緒に出力すると、abcの先頭に空白が入ったことが確認できました。
JavaScriptのpadStartメソッドの使い方まとめ
今回はJavaScriptのpadStart
メソッドの使い方について解説しました。
この記事の内容をまとめます。
・`targetLength`は結果の文字列の長さ(必須)。
・`padString`は埋める文字列(省略可能、デフォルトは空白)。
・数値の0埋めや、文字列の長さを揃える際に便利。
コメント