diff --git a/src/lib/es2015.symbol.wellknown.d.ts b/src/lib/es2015.symbol.wellknown.d.ts index c8250c10a20cb..cbac3ba5682b8 100644 --- a/src/lib/es2015.symbol.wellknown.d.ts +++ b/src/lib/es2015.symbol.wellknown.d.ts @@ -219,9 +219,9 @@ interface String { match(matcher: { [Symbol.match](string: string): RegExpMatchArray | null; }): RegExpMatchArray | null; /** - * Replaces one or more occurrences of substrings that match the method provided by `searchValue`. + * Passes a string and {@linkcode replaceValue} to the [Symbol.replace] method on {@linkcode searchValue}. This method is expected to implement its own replacement algorithm. * @param searchValue An object that supports searching for and replacing matches within a string. - * @param replacer The replacement text. + * @param replaceValue The replacement text. */ replace(searchValue: { [Symbol.replace](string: string, replaceValue: string): string; }, replaceValue: string): string; diff --git a/src/lib/es5.d.ts b/src/lib/es5.d.ts index a743cb0a073fb..43f30e668d99a 100644 --- a/src/lib/es5.d.ts +++ b/src/lib/es5.d.ts @@ -429,8 +429,8 @@ interface String { /** * Replaces text in a string, using a regular expression or search string. - * @param searchValue A string to search for. - * @param replaceValue A string containing the text to replace. When the searchvalue is a string, only the first match is replaced. If the searchValue is a Regexp, all matches are replaced if the g flag is set. Otherwise only the first one is. + * @param searchValue A string or regular expression to search for. + * @param replaceValue A string containing the text to replace. When the {@linkcode searchValue} is a string, only the first match is replaced. If the {@linkcode searchValue} is a RegExp, all matches are replaced if the g flag is set. Otherwise only the first one is. */ replace(searchValue: string | RegExp, replaceValue: string): string; diff --git a/tests/baselines/reference/completionsStringMethods.baseline b/tests/baselines/reference/completionsStringMethods.baseline index 0d3fe39d755c9..00fde327a214c 100644 --- a/tests/baselines/reference/completionsStringMethods.baseline +++ b/tests/baselines/reference/completionsStringMethods.baseline @@ -1048,7 +1048,7 @@ "kind": "space" }, { - "text": "A string to search for.", + "text": "A string or regular expression to search for.", "kind": "text" } ] @@ -1065,7 +1065,53 @@ "kind": "space" }, { - "text": "A string containing the text to replace for every successful match of searchValue in this string.", + "text": "A string containing the text to replace. When the ", + "kind": "text" + }, + { + "text": "{@linkcode ", + "kind": "link" + }, + { + "text": "searchValue", + "kind": "linkName", + "target": { + "fileName": "lib.d.ts", + "textSpan": { + "start": 19079, + "length": 28 + } + } + }, + { + "text": "}", + "kind": "link" + }, + { + "text": " is a string, only the first match is replaced. If the ", + "kind": "text" + }, + { + "text": "{@linkcode ", + "kind": "link" + }, + { + "text": "searchValue", + "kind": "linkName", + "target": { + "fileName": "lib.d.ts", + "textSpan": { + "start": 19079, + "length": 28 + } + } + }, + { + "text": "}", + "kind": "link" + }, + { + "text": " is a RegExp, all matches are replaced if the g flag is set. Otherwise only the first one is.", "kind": "text" } ]