Skip to content

padStart (Lodash 互換性)

JavaScript の String.prototype.padStart を使用してください

この padStart 関数は、文字列以外の値の処理により、動作が遅くなります。

代わりに、より高速で現代的な JavaScript の String.prototype.padStart を使用してください。

文字列の前にパディングを追加して、指定された長さまで伸ばします。

typescript
const padded = padStart(str, length, chars);

参照

padStart(str, length?, chars?)

文字列が希望する長さより短い場合に、前にパディング文字を追加して長さを合わせたい場合は padStart を使用してください。

typescript
import { padStart } from 'es-toolkit/compat';

// 空白でパディング
padStart('abc', 6);
// Returns: '   abc'

// 特定の文字でパディング
padStart('abc', 6, '_-');
// Returns: '_-_abc'

// 元の長さがより長い場合はそのまま返す
padStart('abc', 3);
// Returns: 'abc'

nullundefined は空文字列として処理されます。

typescript
import { padStart } from 'es-toolkit/compat';

padStart(null, 5, '*');
// Returns: '*****'

padStart(undefined, 3);
// Returns: '   '

パラメータ

  • str (string,オプション): パディングを追加する文字列です。
  • length (number,オプション): 希望する最終的な文字列の長さです。デフォルトは 0 です。
  • chars (string,オプション): パディングに使用する文字です。デフォルトは ' '(空白)です。

戻り値

(string): 前にパディングが追加された文字列を返します。

MIT ライセンスの下で配布されています。