Typo in String#match (lib.es2015.symbol.wellknown) #36299

Activity

1. Ryan Cavanaugh (RyanCavanaugh)

   added

   BugA bug in TypeScriptA bug in TypeScript

   on Jan 21, 2020
2. Ryan Cavanaugh (RyanCavanaugh)

   added this to the Backlog milestone on Jan 21, 2020
3. Ryan Cavanaugh (RyanCavanaugh)

   added

   Domain: lib.d.tsThe issue relates to the different libraries shipped with TypeScriptThe issue relates to the different libraries shipped with TypeScript

   on Jan 21, 2020
4. G-Rath commented on Feb 18, 2020

   

   Gareth Jones (G-Rath)

   on Feb 18, 2020

   Author

   More actions

   I've just found a similar typo in the RegExp interface in es5.lib:

   TypeScript/src/lib/es5.d.ts

   Lines 912 to 913 in d2c5d54

   	/** Returns a copy of the text of the regular expression pattern. Read-only. The regExp argument is a Regular expression object. It can be a variable name or a literal. */
   	readonly source: string;

   The last part of the comment of the comment doesn't seem relevant:

   The regExp argument is a Regular expression object. It can be a variable name or a literal.

   My guess is that is the description for the regexp param taken by #match, which reads very similar:

   TypeScript/src/lib/es5.d.ts

   Lines 416 to 420 in d2c5d54

   	/**
   	* Matches a string with a regular expression, and returns an array containing the results of that search.
   	* @param regexp A variable name or string literal containing the regular expression pattern and flags.
   	*/
   	match(regexp: string | RegExp): RegExpMatchArray | null;
5. sebmjoll commented on Mar 6, 2020

   

   Sébastien Paumier (sebmjoll)

   on Mar 6, 2020

   More actions

   I have found another comment issue in replace():

   /**
    * Replaces text in a string, using an object that supports replacement within a string.
    * @param searchValue A object can search for and replace matches within a string.
    * @param replaceValue A string containing the text to replace for every successful match of searchValue in this string.
    */
    replace(searchValue: { [Symbol.replace](string: string, replaceValue: string): string; }, replaceValue: string): string;
   

   This comment is misleading because this function replaces all occurrences when the pattern is a regular expression but only the first occurrence when it is a literal as explained in https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace :

   The replace() method returns a new string with some or all matches of a pattern replaced by a replacement. The pattern can be a string or a RegExp, and the replacement can be a string or a function to be called for each match. If pattern is a string, only the first occurrence will be replaced.

   which is confirmed by running the following code:

   console.log("foo".replace("o", "O")); // => fOo
   console.log("foo".replace(/o/g, "O")); // => fOO
   
6. hikmetba-bit

   added a commit that references this issue on Sep 19, 2026

   Remove misplaced parameter description from RegExp#source JSDoc

   ...

   This issue will close once commit 485428d is merged into the 'main' branch.

   485428d
7. Jake Bailey (jakebailey)

   closed this as completedin #64352on Sep 21, 2026