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

【Node.js24.x】String::padStart()メソッドの使い方

padStartメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

padStartメソッドは、文字列の先頭に特定の文字を挿入し、指定された長さに揃える処理を実行するメソッドです。主に表示の整形や、固定長データの作成などで文字列の桁数を揃えたい場合に利用されます。

このメソッドは、まず第一引数に目標とする文字列の総文字数であるtargetLengthを受け取ります。もし元の文字列の長さがこのtargetLength以上である場合、パディングは行われず、元の文字列がそのまま返されます。パディングが必要な場合、第二引数としてオプションで指定できるpadStringを用いて、文字列の先頭からtargetLengthに達するまで繰り返し文字が挿入されます。padStringを省略した場合、デフォルトで半角スペースがパディング文字として使用されます。

padStartメソッドは、元の文字列を変更することなく、新しく生成されたパディング済みの文字列を返します。例えば、数値を表示する際に「1」を「001」のようにゼロで埋めて桁数を揃えたい場合や、日時表示で「9時」を「09時」と整形したい場合などに非常に便利です。Node.js環境における文字列操作において、統一されたフォーマットでの出力を実現するために役立つ機能です。

構文(syntax)

1const originalString = "5";
2const paddedString = originalString.padStart(3, "0");

引数(parameters)

targetLength, padString = ' '

  • targetLength: string: パディング後の文字列の合計長を指定する整数
  • padString: string = ' ': パディングに使用する文字列。指定しない場合はスペースが使用されます。

戻り値(return)

string

指定された長さになるまで、現在の文字列の先頭に指定した文字列を追加した新しい文字列を返します。

関連コンテンツ

関連プログラミング言語