source: node_modules/es-toolkit/dist/string/pad.d.ts

Last change on this file was a762898, checked in by istevanoska <ilinastevanoska@…>, 5 months ago

Added visualizations

  • Property mode set to 100644
File size: 987 bytes
Line 
1/**
2 * Pads string on the left and right sides if it's shorter than length. Padding characters are truncated if they can't be evenly divided by length.
3 * 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.
4 *
5 * @param {string} str - The string to pad.
6 * @param {number} [length] - The length of the resulting string once padded.
7 * @param {string} [chars] - The character(s) to use for padding.
8 * @returns {string} - The padded string, or the original string if padding is not required.
9 *
10 * @example
11 * const result1 = pad('abc', 8); // result will be ' abc '
12 * const result2 = pad('abc', 8, '_-'); // result will be '_-abc_-_'
13 * const result3 = pad('abc', 3); // result will be 'abc'
14 * const result4 = pad('abc', 2); // result will be 'abc'
15 *
16 */
17declare function pad(str: string, length: number, chars?: string): string;
18
19export { pad };
Note: See TracBrowser for help on using the repository browser.