es-toolkit 1.13.1-dev.359 → 1.13.1-dev.360

package/dist/compat/index.d.mts

@@ -92,6 +92,7 @@ export { kebabCase } from '../string/kebabCase.mjs';
 export { lowerCase } from '../string/lowerCase.mjs';
 export { startCase } from '../string/startCase.mjs';
 export { capitalize } from '../string/capitalize.mjs';
+export { padStart } from '../string/padStart.mjs';
 export { chunk } from './array/chunk.mjs';
 export { concat } from './array/concat.mjs';
 export { difference } from './array/difference.mjs';

package/dist/compat/index.d.ts

@@ -92,6 +92,7 @@ export { kebabCase } from '../string/kebabCase.js';
 export { lowerCase } from '../string/lowerCase.js';
 export { startCase } from '../string/startCase.js';
 export { capitalize } from '../string/capitalize.js';
+export { padStart } from '../string/padStart.js';
 export { chunk } from './array/chunk.js';
 export { concat } from './array/concat.js';
 export { difference } from './array/difference.js';

package/dist/compat/index.js

@@ -491,6 +491,7 @@ exports.camelCase = string_index.camelCase;
 exports.capitalize = string_index.capitalize;
 exports.kebabCase = string_index.kebabCase;
 exports.lowerCase = string_index.lowerCase;
+exports.padStart = string_index.padStart;
 exports.snakeCase = string_index.snakeCase;
 exports.startCase = string_index.startCase;
 exports.chunk = chunk;

package/dist/compat/index.mjs

@@ -92,6 +92,7 @@ export { kebabCase } from '../string/kebabCase.mjs';
 export { lowerCase } from '../string/lowerCase.mjs';
 export { startCase } from '../string/startCase.mjs';
 export { capitalize } from '../string/capitalize.mjs';
+export { padStart } from '../string/padStart.mjs';
 export { chunk } from './array/chunk.mjs';
 export { concat } from './array/concat.mjs';
 export { difference } from './array/difference.mjs';

package/dist/index.d.mts

@@ -99,3 +99,4 @@ export { kebabCase } from './string/kebabCase.mjs';
 export { lowerCase } from './string/lowerCase.mjs';
 export { startCase } from './string/startCase.mjs';
 export { capitalize } from './string/capitalize.mjs';
+export { padStart } from './string/padStart.mjs';

package/dist/index.d.ts

@@ -99,3 +99,4 @@ export { kebabCase } from './string/kebabCase.js';
 export { lowerCase } from './string/lowerCase.js';
 export { startCase } from './string/startCase.js';
 export { capitalize } from './string/capitalize.js';
+export { padStart } from './string/padStart.js';

package/dist/index.js

@@ -114,5 +114,6 @@ exports.camelCase = string_index.camelCase;
 exports.capitalize = string_index.capitalize;
 exports.kebabCase = string_index.kebabCase;
 exports.lowerCase = string_index.lowerCase;
+exports.padStart = string_index.padStart;
 exports.snakeCase = string_index.snakeCase;
 exports.startCase = string_index.startCase;

package/dist/index.mjs

@@ -99,3 +99,4 @@ export { kebabCase } from './string/kebabCase.mjs';
 export { lowerCase } from './string/lowerCase.mjs';
 export { startCase } from './string/startCase.mjs';
 export { capitalize } from './string/capitalize.mjs';
+export { padStart } from './string/padStart.mjs';

package/dist/string/index.d.mts

@@ -4,3 +4,4 @@ export { kebabCase } from './kebabCase.mjs';
 export { lowerCase } from './lowerCase.mjs';
 export { startCase } from './startCase.mjs';
 export { capitalize } from './capitalize.mjs';
+export { padStart } from './padStart.mjs';

package/dist/string/index.d.ts

@@ -4,3 +4,4 @@ export { kebabCase } from './kebabCase.js';
 export { lowerCase } from './lowerCase.js';
 export { startCase } from './startCase.js';
 export { capitalize } from './capitalize.js';
+export { padStart } from './padStart.js';

package/dist/string/index.js

@@ -52,9 +52,17 @@ function startCase(str) {
     return result;
 }
 
+const padStart = (str, length = 0, chars = ' ') => {
+    if (Number.isSafeInteger(length) && length > str.length && chars.length > 0) {
+        return str.padStart(length, chars);
+    }
+    return str;
+};
+
 exports.camelCase = camelCase;
 exports.capitalize = capitalize;
 exports.kebabCase = kebabCase;
 exports.lowerCase = lowerCase;
+exports.padStart = padStart;
 exports.snakeCase = snakeCase;
 exports.startCase = startCase;

package/dist/string/index.mjs

@@ -4,3 +4,4 @@ export { kebabCase } from './kebabCase.mjs';
 export { lowerCase } from './lowerCase.mjs';
 export { startCase } from './startCase.mjs';
 export { capitalize } from './capitalize.mjs';
+export { padStart } from './padStart.mjs';

package/dist/string/padStart.d.mts

@@ -0,0 +1,20 @@
+/**
+ * Pads the start of a string with a given character until it reaches the specified length.
+ * If the length is less than or equal to the original string's length, or if the padding character is an empty string,
+ * the original string is returned unchanged.
+ *
+ * @template T - The type of the input string.
+ * @param {T} str - The string to pad.
+ * @param {number} [length=0] - The length of the resulting string once padded. Default is 0.
+ * @param {string} [chars=' '] - The character(s) to use for padding. Default is a single space.
+ * @returns {string} - The padded string, or the original string if padding is not required.
+ *
+ * @example
+ * const result1 = padStart('abc', 6);          // result will be '   abc'
+ * const result2 = padStart('abc', 6, '_-');    // result will be '_-_abc'
+ * const result3 = padStart('abc', 3);          // result will be 'abc'
+ * const result4 = padStart('abc', 2);          // result will be 'abc'
+ */
+declare const padStart: <T extends string>(str: T, length?: number, chars?: string) => string;
+
+export { padStart };

package/dist/string/padStart.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Pads the start of a string with a given character until it reaches the specified length.
+ * If the length is less than or equal to the original string's length, or if the padding character is an empty string,
+ * the original string is returned unchanged.
+ *
+ * @template T - The type of the input string.
+ * @param {T} str - The string to pad.
+ * @param {number} [length=0] - The length of the resulting string once padded. Default is 0.
+ * @param {string} [chars=' '] - The character(s) to use for padding. Default is a single space.
+ * @returns {string} - The padded string, or the original string if padding is not required.
+ *
+ * @example
+ * const result1 = padStart('abc', 6);          // result will be '   abc'
+ * const result2 = padStart('abc', 6, '_-');    // result will be '_-_abc'
+ * const result3 = padStart('abc', 3);          // result will be 'abc'
+ * const result4 = padStart('abc', 2);          // result will be 'abc'
+ */
+declare const padStart: <T extends string>(str: T, length?: number, chars?: string) => string;
+
+export { padStart };

package/dist/string/padStart.mjs

@@ -0,0 +1,8 @@
+const padStart = (str, length = 0, chars = ' ') => {
+    if (Number.isSafeInteger(length) && length > str.length && chars.length > 0) {
+        return str.padStart(length, chars);
+    }
+    return str;
+};
+
+export { padStart };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "es-toolkit",
   "description": "A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.",
-  "version": "1.13.1-dev.359+2d1c4063",
+  "version": "1.13.1-dev.360+8249ed25",
   "homepage": "https://es-toolkit.slash.page",
   "bugs": "https://github.com/toss/es-toolkit/issues",
   "repository": {