Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Oct 31, 2023
1 parent 41ff7b6 commit ce8a9e3
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 12 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ The namespace exposes the following string manipulation functions:
- <span class="signature">[`repeat( str, n )`][@stdlib/string/repeat]</span><span class="delimiter">: </span><span class="description">repeat a string a specified number of times and return the concatenated result.</span>
- <span class="signature">[`replaceBefore( str, search, replacement )`][@stdlib/string/replace-before]</span><span class="delimiter">: </span><span class="description">replace the substring before the first occurrence of a specified search string.</span>
- <span class="signature">[`replace( str, search, newval )`][@stdlib/string/replace]</span><span class="delimiter">: </span><span class="description">replace search occurrences with a replacement string.</span>
- <span class="signature">[`reverseString( str )`][@stdlib/string/reverse]</span><span class="delimiter">: </span><span class="description">reverse a string.</span>
- <span class="signature">[`reverseString( str[, options] )`][@stdlib/string/reverse]</span><span class="delimiter">: </span><span class="description">reverse a string.</span>
- <span class="signature">[`rpad( str, len[, pad] )`][@stdlib/string/right-pad]</span><span class="delimiter">: </span><span class="description">right pad a string.</span>
- <span class="signature">[`rtrimN( str, n[, chars] )`][@stdlib/string/right-trim-n]</span><span class="delimiter">: </span><span class="description">trim `n` characters from the end of a string.</span>
- <span class="signature">[`rtrim( str )`][@stdlib/string/right-trim]</span><span class="delimiter">: </span><span class="description">trim whitespace characters from the end of a string.</span>
Expand Down
19 changes: 8 additions & 11 deletions docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -855,23 +855,20 @@ interface Namespace {
* Reverses a string.
*
* @param str - input string
* @param options - options
* @returns reversed string
*
* @example
* var out = ns.reverseString( 'last man standing' );
* var out = ns.reverseString( 'last man standing', {
* 'mode': 'code_unit'
* });
* // returns 'gnidnats nam tsal'
*
* @example
* var out = ns.reverseString( 'presidential election' );
* // returns 'noitcele laitnediserp'
*
* @example
* var out = ns.reverseString( 'javaScript' );
* // returns 'tpircSavaj'
*
* @example
* var out = ns.reverseString( 'Hidden Treasures' );
* // returns 'serusaerT neddiH'
* var out = ns.reverseString( '🐶🐮🐷🐰🐸', {
* 'mode': 'grapheme'
* });
* // returns '🐸🐰🐷🐮🐶'
*/
reverseString: typeof reverseString;

Expand Down

0 comments on commit ce8a9e3

Please sign in to comment.