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 Dec 26, 2023
1 parent ddbadda commit 998b1f4
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 4 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/npm_downloads.yml
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,8 @@ jobs:

# Send data to events server:
- name: 'Post data'
# Pin action to full length commit SHA corresponding to v3.0.3:
uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629
# Pin action to full length commit SHA
uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3
env:
webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }}
webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }}
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/test_coverage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,8 @@ jobs:

# Send data to events server:
- name: 'Post data'
# Pin action to full length commit SHA corresponding to v3.0.3:
uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629
# Pin action to full length commit SHA
uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3
env:
webhook_url: ${{ secrets.STDLIB_COVERAGE_URL }}
webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }}
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ The namespace exposes the following string manipulation functions:
- <span class="signature">[`ltrimN( str, n[, chars] )`][@stdlib/string/left-trim-n]</span><span class="delimiter">: </span><span class="description">trim `n` characters from the end of a string.</span>
- <span class="signature">[`ltrim( str )`][@stdlib/string/left-trim]</span><span class="delimiter">: </span><span class="description">trim whitespace characters from the beginning of a string.</span>
- <span class="signature">[`lowercase( str )`][@stdlib/string/lowercase]</span><span class="delimiter">: </span><span class="description">convert a string to lowercase.</span>
- <span class="signature">[`nextCodePointIndex( string[, fromIndex] )`][@stdlib/string/next-code-point-index]</span><span class="delimiter">: </span><span class="description">return the position of the next Unicode code point in a string after a specified position.</span>
- <span class="signature">[`nextGraphemeClusterBreak( string[, fromIndex] )`][@stdlib/string/next-grapheme-cluster-break]</span><span class="delimiter">: </span><span class="description">return the next extended grapheme cluster break in a string after a specified position.</span>
- <span class="signature">[`numGraphemeClusters( str )`][@stdlib/string/num-grapheme-clusters]</span><span class="delimiter">: </span><span class="description">return the number of grapheme clusters in a string.</span>
- <span class="signature">[`num2words( value[, options] )`][@stdlib/string/num2words]</span><span class="delimiter">: </span><span class="description">convert a number to a word representation.</span>
Expand Down Expand Up @@ -272,6 +273,8 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].

[@stdlib/string/lowercase]: https://github.com/stdlib-js/string/tree/main/lowercase

[@stdlib/string/next-code-point-index]: https://github.com/stdlib-js/string/tree/main/next-code-point-index

[@stdlib/string/next-grapheme-cluster-break]: https://github.com/stdlib-js/string/tree/main/next-grapheme-cluster-break

[@stdlib/string/num-grapheme-clusters]: https://github.com/stdlib-js/string/tree/main/num-grapheme-clusters
Expand Down
24 changes: 24 additions & 0 deletions base/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ The namespace contains the following functions:

<div class="namespace-toc">

- <span class="signature">[`altcase( str )`][@stdlib/string/base/altcase]</span><span class="delimiter">: </span><span class="description">convert a string to alternate case.</span>
- <span class="signature">[`camelcase( str )`][@stdlib/string/base/camelcase]</span><span class="delimiter">: </span><span class="description">convert a string to camel case.</span>
- <span class="signature">[`capitalize( str )`][@stdlib/string/base/capitalize]</span><span class="delimiter">: </span><span class="description">capitalize the first character in a string.</span>
- <span class="signature">[`codePointAt( string, position, backward )`][@stdlib/string/base/code-point-at]</span><span class="delimiter">: </span><span class="description">return a Unicode code point from a string at a specified position.</span>
Expand All @@ -71,15 +72,22 @@ The namespace contains the following functions:
- <span class="signature">[`removeFirstCodePoint( str, n )`][@stdlib/string/base/remove-first-code-point]</span><span class="delimiter">: </span><span class="description">remove the first `n` Unicode code points of a string.</span>
- <span class="signature">[`removeFirstGraphemeCluster( str, n )`][@stdlib/string/base/remove-first-grapheme-cluster]</span><span class="delimiter">: </span><span class="description">remove the first `n` grapheme clusters (i.e., user-perceived characters) of a string.</span>
- <span class="signature">[`removeFirst( str, n )`][@stdlib/string/base/remove-first]</span><span class="delimiter">: </span><span class="description">remove the first `n` UTF-16 code units of a string.</span>
- <span class="signature">[`removeLastCodePoint( str, n )`][@stdlib/string/base/remove-last-code-point]</span><span class="delimiter">: </span><span class="description">remove the last `n` Unicode code points of a string.</span>
- <span class="signature">[`removeLastGraphemeCluster( str, n )`][@stdlib/string/base/remove-last-grapheme-cluster]</span><span class="delimiter">: </span><span class="description">remove the last `n` grapheme clusters (i.e., user-perceived characters) of a string.</span>
- <span class="signature">[`removeLast( str, n )`][@stdlib/string/base/remove-last]</span><span class="delimiter">: </span><span class="description">remove the last `n` UTF-16 code units of a string.</span>
- <span class="signature">[`repeat( str, n )`][@stdlib/string/base/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/base/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/base/replace]</span><span class="delimiter">: </span><span class="description">replace search occurrences with a replacement string.</span>
- <span class="signature">[`reverseCodePoints( str )`][@stdlib/string/base/reverse-code-points]</span><span class="delimiter">: </span><span class="description">reverse the Unicode code points of a string.</span>
- <span class="signature">[`reverseGraphemeClusters( str )`][@stdlib/string/base/reverse-grapheme-clusters]</span><span class="delimiter">: </span><span class="description">reverse the grapheme clusters (i.e., user-perceived characters) of a string.</span>
- <span class="signature">[`reverse( str )`][@stdlib/string/base/reverse]</span><span class="delimiter">: </span><span class="description">reverse the UTF-16 code units of a string.</span>
- <span class="signature">[`rpad( str, len, pad )`][@stdlib/string/base/right-pad]</span><span class="delimiter">: </span><span class="description">right pad a string.</span>
- <span class="signature">[`rtrim( str )`][@stdlib/string/base/right-trim]</span><span class="delimiter">: </span><span class="description">trim whitespace characters from the end of a string.</span>
- <span class="signature">[`snakecase( str )`][@stdlib/string/base/snakecase]</span><span class="delimiter">: </span><span class="description">convert a string to snake case.</span>
- <span class="signature">[`startcase( str )`][@stdlib/string/base/startcase]</span><span class="delimiter">: </span><span class="description">capitalize the first letter of each word in a string.</span>
- <span class="signature">[`startsWith( str, search, position )`][@stdlib/string/base/starts-with]</span><span class="delimiter">: </span><span class="description">test if a string starts with the characters of another string.</span>
- <span class="signature">[`trim( str )`][@stdlib/string/base/trim]</span><span class="delimiter">: </span><span class="description">trim whitespace characters from the beginning and end of a string.</span>
- <span class="signature">[`truncateMiddle( str, len, seq )`][@stdlib/string/base/truncate-middle]</span><span class="delimiter">: </span><span class="description">truncate the middle UTF-16 code units of a string to return a string having a specified length.</span>
- <span class="signature">[`uncapitalize( str )`][@stdlib/string/base/uncapitalize]</span><span class="delimiter">: </span><span class="description">uncapitalize the first character of a string.</span>
- <span class="signature">[`uppercase( str )`][@stdlib/string/base/uppercase]</span><span class="delimiter">: </span><span class="description">convert a string to uppercase.</span>

Expand Down Expand Up @@ -156,6 +164,8 @@ str = ns.trim( str );

<!-- <toc-links> -->

[@stdlib/string/base/altcase]: https://github.com/stdlib-js/string/tree/main/base/altcase

[@stdlib/string/base/camelcase]: https://github.com/stdlib-js/string/tree/main/base/camelcase

[@stdlib/string/base/capitalize]: https://github.com/stdlib-js/string/tree/main/base/capitalize
Expand Down Expand Up @@ -208,12 +218,24 @@ str = ns.trim( str );

[@stdlib/string/base/remove-first]: https://github.com/stdlib-js/string/tree/main/base/remove-first

[@stdlib/string/base/remove-last-code-point]: https://github.com/stdlib-js/string/tree/main/base/remove-last-code-point

[@stdlib/string/base/remove-last-grapheme-cluster]: https://github.com/stdlib-js/string/tree/main/base/remove-last-grapheme-cluster

[@stdlib/string/base/remove-last]: https://github.com/stdlib-js/string/tree/main/base/remove-last

[@stdlib/string/base/repeat]: https://github.com/stdlib-js/string/tree/main/base/repeat

[@stdlib/string/base/replace-before]: https://github.com/stdlib-js/string/tree/main/base/replace-before

[@stdlib/string/base/replace]: https://github.com/stdlib-js/string/tree/main/base/replace

[@stdlib/string/base/reverse-code-points]: https://github.com/stdlib-js/string/tree/main/base/reverse-code-points

[@stdlib/string/base/reverse-grapheme-clusters]: https://github.com/stdlib-js/string/tree/main/base/reverse-grapheme-clusters

[@stdlib/string/base/reverse]: https://github.com/stdlib-js/string/tree/main/base/reverse

[@stdlib/string/base/right-pad]: https://github.com/stdlib-js/string/tree/main/base/right-pad

[@stdlib/string/base/right-trim]: https://github.com/stdlib-js/string/tree/main/base/right-trim
Expand All @@ -226,6 +248,8 @@ str = ns.trim( str );

[@stdlib/string/base/trim]: https://github.com/stdlib-js/string/tree/main/base/trim

[@stdlib/string/base/truncate-middle]: https://github.com/stdlib-js/string/tree/main/base/truncate-middle

[@stdlib/string/base/uncapitalize]: https://github.com/stdlib-js/string/tree/main/base/uncapitalize

[@stdlib/string/base/uppercase]: https://github.com/stdlib-js/string/tree/main/base/uppercase
Expand Down
3 changes: 3 additions & 0 deletions base/distances/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ The namespace contains the following functions:

<div class="namespace-toc">

- <span class="signature">[`hammingDistance( s1, s2 )`][@stdlib/string/base/distances/hamming]</span><span class="delimiter">: </span><span class="description">calculate the Hamming distance between two equal-length strings.</span>
- <span class="signature">[`levenshteinDistance( s1, s2 )`][@stdlib/string/base/distances/levenshtein]</span><span class="delimiter">: </span><span class="description">calculate the Levenshtein (edit) distance between two strings.</span>

</div>
Expand Down Expand Up @@ -97,6 +98,8 @@ var dist = ns.levenshteinDistance( 'algorithm', 'altruistic' );

<!-- <toc-links> -->

[@stdlib/string/base/distances/hamming]: https://github.com/stdlib-js/string/tree/main/base/distances/hamming

[@stdlib/string/base/distances/levenshtein]: https://github.com/stdlib-js/string/tree/main/base/distances/levenshtein

<!-- </toc-links> -->
Expand Down

0 comments on commit 998b1f4

Please sign in to comment.