From 318cc264dc24c03b060f9aa2a839d33986cb1b93 Mon Sep 17 00:00:00 2001 From: Spencer Young Date: Sun, 24 May 2026 19:26:42 -0700 Subject: [PATCH 1/2] fix misleading maxLength param on string pad* methods --- src/lib/es2017.string.d.ts | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) diff --git a/src/lib/es2017.string.d.ts b/src/lib/es2017.string.d.ts index 80139e3712ec5..746328323146c 100644 --- a/src/lib/es2017.string.d.ts +++ b/src/lib/es2017.string.d.ts @@ -1,27 +1,31 @@ interface String { /** - * Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. - * The padding is applied from the start (left) of the current string. + * Pads this string with a given string (repeated and/or truncated, if needed) so that the resulting string has a given length. + * The padding is applied from the start of this string. * - * @param maxLength The length of the resulting string once the current string has been padded. - * If this parameter is smaller than the current string's length, the current string will be returned as it is. + * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/padStart) * - * @param fillString The string to pad the current string with. - * If this string is too long, it will be truncated and the left-most part will be applied. - * The default value for this parameter is " " (U+0020). + * @param targetLength The length of the resulting string once the current `str` has been padded. + * If the value is less than or equal to `str.length`, then `str` is returned as-is. + * + * @param padString The string to pad the current `str` with. + * If `padString` is too long to stay within `targetLength`, it will be truncated from the end. + * The default value is the space character (U+0020). */ - padStart(maxLength: number, fillString?: string): string; + padStart(targetLength: number, padString?: string): string; /** - * Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. - * The padding is applied from the end (right) of the current string. + * Pads this string with a given string (repeated and/or truncated, if needed) so that the resulting string has a given length. + * The padding is applied from the end of this string. + * + * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/padEnd) * - * @param maxLength The length of the resulting string once the current string has been padded. - * If this parameter is smaller than the current string's length, the current string will be returned as it is. + * @param targetLength The length of the resulting string once the current `str` has been padded. + * If the value is less than or equal to `str.length`, then `str` is returned as-is. * - * @param fillString The string to pad the current string with. - * If this string is too long, it will be truncated and the left-most part will be applied. - * The default value for this parameter is " " (U+0020). + * @param padString The string to pad the current `str` with. + * If `padString` is too long to stay within `targetLength`, it will be truncated from the end. + * The default value is the space character (U+0020). */ - padEnd(maxLength: number, fillString?: string): string; + padEnd(targetLength: number, padString?: string): string; } From aabbe022a38ea45895c102714137acc11279fc8e Mon Sep 17 00:00:00 2001 From: Spencer Young Date: Tue, 26 May 2026 09:58:03 -0700 Subject: [PATCH 2/2] 'this string' -> 'the current string' --- src/lib/es2017.string.d.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/lib/es2017.string.d.ts b/src/lib/es2017.string.d.ts index 746328323146c..4bf9595fe3f9d 100644 --- a/src/lib/es2017.string.d.ts +++ b/src/lib/es2017.string.d.ts @@ -1,7 +1,7 @@ interface String { /** - * Pads this string with a given string (repeated and/or truncated, if needed) so that the resulting string has a given length. - * The padding is applied from the start of this string. + * Pads the current string with a given string (repeated and/or truncated, if needed) so that the resulting string has a given length. + * The padding is applied from the start of the current string. * * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/padStart) * @@ -15,8 +15,8 @@ interface String { padStart(targetLength: number, padString?: string): string; /** - * Pads this string with a given string (repeated and/or truncated, if needed) so that the resulting string has a given length. - * The padding is applied from the end of this string. + * Pads the current string with a given string (repeated and/or truncated, if needed) so that the resulting string has a given length. + * The padding is applied from the end of the current string. * * [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/padEnd) *