Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
retorquere committed Feb 26, 2025
1 parent b92974d commit 151db66
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions content/key-manager/formatter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1144,15 +1144,15 @@ export class PatternFormatter {

/**
* replaces spaces in the value passed in. You can specify what to replace it with by adding it as a
* parameter, e.g `.condense('\_')` will replace spaces with underscores. Equivalent to `.replace(/\s+/g, sep)`.
* parameter, e.g `.condense('_')` will replace spaces with underscores. Equivalent to `.replace(/\s+/g, sep)`.
* @param sep replacement character
*/
public _condense(input: string, sep: string = ''): string { // eslint-disable-line @typescript-eslint/no-inferrable-types
return input.replace(/\s+/g, sep)
}

/**
* prefixes with its parameter, so `.prefix('\_')` will add an underscore to the front if, and only if, the value
* prefixes with its parameter, so `.prefix('_')` will add an underscore to the front if, and only if, the value
* it is supposed to prefix isn't empty.
* @param prefix prefix string
*/
Expand All @@ -1161,7 +1161,7 @@ export class PatternFormatter {
}

/**
* postfixes with its parameter, so `postfix('\_')` will add an underscore to the end if, and only if, the value
* postfixes with its parameter, so `postfix('_')` will add an underscore to the end if, and only if, the value
* it is supposed to postfix isn't empty
* @param postfix postfix string
*/
Expand Down
6 changes: 3 additions & 3 deletions site/data/citekeyformatters/filters.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
},
{
"summary": "<b>condense</b>(sep: string = &#39;&#39;)",
"description": "<p>replaces spaces in the value passed in. You can specify what to replace it with by adding it as a\nparameter, e.g <code>.condense('\\_')</code> will replace spaces with underscores. Equivalent to <code>.replace(/\\s+/g, sep)</code>.</p>"
"description": "<p>replaces spaces in the value passed in. You can specify what to replace it with by adding it as a\nparameter, e.g <code>.condense('_')</code> will replace spaces with underscores. Equivalent to <code>.replace(/\\s+/g, sep)</code>.</p>"
},
{
"summary": "<b>default</b>(text: string)",
Expand Down Expand Up @@ -89,11 +89,11 @@
},
{
"summary": "<b>postfix</b>(postfix: string)",
"description": "<p>postfixes with its parameter, so <code>postfix('\\_')</code> will add an underscore to the end if, and only if, the value\nit is supposed to postfix isn't empty</p>"
"description": "<p>postfixes with its parameter, so <code>postfix('_')</code> will add an underscore to the end if, and only if, the value\nit is supposed to postfix isn't empty</p>"
},
{
"summary": "<b>prefix</b>(prefix: string)",
"description": "<p>prefixes with its parameter, so <code>.prefix('\\_')</code> will add an underscore to the front if, and only if, the value\nit is supposed to prefix isn't empty.</p>"
"description": "<p>prefixes with its parameter, so <code>.prefix('_')</code> will add an underscore to the front if, and only if, the value\nit is supposed to prefix isn't empty.</p>"
},
{
"summary": "<b>replace</b>(find: (string | RegExp), replace: string)",
Expand Down

0 comments on commit 151db66

Please sign in to comment.