Skip to content

Commit

Permalink
Apply suggestions from code review - Part III
Browse files Browse the repository at this point in the history
Co-authored-by: ST-DDT <[email protected]>
  • Loading branch information
suyashgulati and ST-DDT authored Nov 25, 2023
1 parent af3663f commit 1cdd073
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions src/modules/helpers/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -162,17 +162,19 @@ function legacyRegexpStringParse(
* Parses the given string symbol by symbol and replaces the placeholders with digits (`0` - `9`).
* `!` will be replaced by digits >=2 (`2` - `9`).
*
* Note: This method will be removed in v9.
*
* @internal
*
* @param faker A Faker instance.
* @param faker The Faker instance to use.
* @param string The template string to parse. Defaults to `''`.
* @param symbol The symbol to replace with digits. Defaults to `'#'`.
*
* @example
* faker.helpers.legacyReplaceSymbolWithNumber(this.faker) // ''
* faker.helpers.legacyReplaceSymbolWithNumber(this.faker, '#####') // '04812'
* faker.helpers.legacyReplaceSymbolWithNumber(this.faker, '!####') // '27378'
* faker.helpers.legacyReplaceSymbolWithNumber(this.faker, 'Your pin is: !####') // '29841'
* legacyReplaceSymbolWithNumber(faker) // ''
* legacyReplaceSymbolWithNumber(faker, '#####') // '04812'
* legacyReplaceSymbolWithNumber(faker, '!####') // '27378'
* legacyReplaceSymbolWithNumber(faker, 'Your pin is: !####') // '29841'
*
* @since 8.4.0
*/
Expand Down

0 comments on commit 1cdd073

Please sign in to comment.