Skip to content

Fix(47969): String.prototypr.replace docs fix #50041

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Sep 28, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/lib/es2015.symbol.wellknown.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -219,9 +219,9 @@ interface String {
match(matcher: { [Symbol.match](string: string): RegExpMatchArray | null; }): RegExpMatchArray | null;

/**
* Replaces first match with string or all matches with RegExp.
* @param searchValue A string or RegExp search value.
* @param replaceValue A string containing the text to replace for match.
* 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 replaceValue The replacement text.
*/
replace(searchValue: { [Symbol.replace](string: string, replaceValue: string): string; }, replaceValue: string): string;

Expand Down
4 changes: 2 additions & 2 deletions src/lib/es5.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -423,8 +423,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 for every successful match of searchValue in this string.
* @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 `RegExp`, all matches are replaced if the `g` flag is set (or only those matches at the beginning, if the `y` flag is also present). Otherwise, only the first match of {@linkcode searchValue} is replaced.
*/
replace(searchValue: string | RegExp, replaceValue: string): string;

Expand Down
50 changes: 48 additions & 2 deletions tests/baselines/reference/completionsStringMethods.baseline
Original file line number Diff line number Diff line change
Expand Up @@ -1048,7 +1048,7 @@
"kind": "space"
},
{
"text": "A string to search for.",
"text": "A string or regular expression to search for.",
"kind": "text"
}
]
Expand All @@ -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": 18880,
"length": 28
}
}
},
{
"text": "}",
"kind": "link"
},
{
"text": " is a `RegExp`, all matches are replaced if the `g` flag is set (or only those matches at the beginning, if the `y` flag is also present). Otherwise, only the first match of ",
"kind": "text"
},
{
"text": "{@linkcode ",
"kind": "link"
},
{
"text": "searchValue",
"kind": "linkName",
"target": {
"fileName": "lib.d.ts",
"textSpan": {
"start": 18880,
"length": 28
}
}
},
{
"text": "}",
"kind": "link"
},
{
"text": " is replaced.",
"kind": "text"
}
]
Expand Down