String.prototype.trimStart()

試してみましょう

const greeting = "   Hello world!   ";

console.log(greeting);
// 予想される結果: "   Hello world!   ";

console.log(greeting.trimStart());
// 予想される結果: "Hello world!   ";

構文

trimStart()

trimLeft()

引数

なし。

返値

str の先頭のホワイトスペースを取り除いた新しい文字列です。ホワイトスペースはホワイトスペース文字と改行文字で定義します。

str の先頭にホワイトスペースがなかった場合でも、新しい文字列が返されます（基本的には str のコピー）。

別名

trim() が標準化された後、エンジンは標準外の trimLeft メソッドも実装しました。しかし padStart() との整合を取るため、このメソッドが標準化された際、trimStart という名前が選択されました。ウェブの互換性の理由から、trimLeft も trimStart の別名として残っており、全く同じ関数オブジェクトを示します。エンジンによっては次のような意味になります。

String.prototype.trimLeft.name === "trimStart";

例

trimStart() の使用

次の例は str の先頭から空白を取り除きますが、末尾からは取り除きません。

let str = "   foo  ";

console.log(str.length); // 8

str = str.trimStart();
console.log(str.length); // 5
console.log(str); // 'foo  '

仕様書

ブラウザーの互換性

関連情報

• String.prototype.trimStart のポリフィル (core-js)
• es-shims による String.prototype.trimStart のポリフィル
• String.prototype.trim()
• String.prototype.trimEnd()