diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml index 19d966ad..8e1cc109 100644 --- a/.github/workflows/npm_downloads.yml +++ b/.github/workflows/npm_downloads.yml @@ -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 }} diff --git a/.github/workflows/test_coverage.yml b/.github/workflows/test_coverage.yml index 25dcbeff..1b9adfa4 100644 --- a/.github/workflows/test_coverage.yml +++ b/.github/workflows/test_coverage.yml @@ -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 }} diff --git a/README.md b/README.md index 53f50f26..5a741fce 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,7 @@ The namespace exposes the following string manipulation functions: - [`ltrimN( str, n[, chars] )`][@stdlib/string/left-trim-n]: trim `n` characters from the end of a string. - [`ltrim( str )`][@stdlib/string/left-trim]: trim whitespace characters from the beginning of a string. - [`lowercase( str )`][@stdlib/string/lowercase]: convert a string to lowercase. +- [`nextCodePointIndex( string[, fromIndex] )`][@stdlib/string/next-code-point-index]: return the position of the next Unicode code point in a string after a specified position. - [`nextGraphemeClusterBreak( string[, fromIndex] )`][@stdlib/string/next-grapheme-cluster-break]: return the next extended grapheme cluster break in a string after a specified position. - [`numGraphemeClusters( str )`][@stdlib/string/num-grapheme-clusters]: return the number of grapheme clusters in a string. - [`num2words( value[, options] )`][@stdlib/string/num2words]: convert a number to a word representation. @@ -272,6 +273,8 @@ Copyright © 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 diff --git a/base/README.md b/base/README.md index 1712fdb7..982652b1 100644 --- a/base/README.md +++ b/base/README.md @@ -45,6 +45,7 @@ The namespace contains the following functions:
+- [`altcase( str )`][@stdlib/string/base/altcase]: convert a string to alternate case. - [`camelcase( str )`][@stdlib/string/base/camelcase]: convert a string to camel case. - [`capitalize( str )`][@stdlib/string/base/capitalize]: capitalize the first character in a string. - [`codePointAt( string, position, backward )`][@stdlib/string/base/code-point-at]: return a Unicode code point from a string at a specified position. @@ -71,15 +72,22 @@ The namespace contains the following functions: - [`removeFirstCodePoint( str, n )`][@stdlib/string/base/remove-first-code-point]: remove the first `n` Unicode code points of a string. - [`removeFirstGraphemeCluster( str, n )`][@stdlib/string/base/remove-first-grapheme-cluster]: remove the first `n` grapheme clusters (i.e., user-perceived characters) of a string. - [`removeFirst( str, n )`][@stdlib/string/base/remove-first]: remove the first `n` UTF-16 code units of a string. +- [`removeLastCodePoint( str, n )`][@stdlib/string/base/remove-last-code-point]: remove the last `n` Unicode code points of a string. +- [`removeLastGraphemeCluster( str, n )`][@stdlib/string/base/remove-last-grapheme-cluster]: remove the last `n` grapheme clusters (i.e., user-perceived characters) of a string. +- [`removeLast( str, n )`][@stdlib/string/base/remove-last]: remove the last `n` UTF-16 code units of a string. - [`repeat( str, n )`][@stdlib/string/base/repeat]: repeat a string a specified number of times and return the concatenated result. - [`replaceBefore( str, search, replacement )`][@stdlib/string/base/replace-before]: replace the substring before the first occurrence of a specified search string. - [`replace( str, search, newval )`][@stdlib/string/base/replace]: replace search occurrences with a replacement string. +- [`reverseCodePoints( str )`][@stdlib/string/base/reverse-code-points]: reverse the Unicode code points of a string. +- [`reverseGraphemeClusters( str )`][@stdlib/string/base/reverse-grapheme-clusters]: reverse the grapheme clusters (i.e., user-perceived characters) of a string. +- [`reverse( str )`][@stdlib/string/base/reverse]: reverse the UTF-16 code units of a string. - [`rpad( str, len, pad )`][@stdlib/string/base/right-pad]: right pad a string. - [`rtrim( str )`][@stdlib/string/base/right-trim]: trim whitespace characters from the end of a string. - [`snakecase( str )`][@stdlib/string/base/snakecase]: convert a string to snake case. - [`startcase( str )`][@stdlib/string/base/startcase]: capitalize the first letter of each word in a string. - [`startsWith( str, search, position )`][@stdlib/string/base/starts-with]: test if a string starts with the characters of another string. - [`trim( str )`][@stdlib/string/base/trim]: trim whitespace characters from the beginning and end of a string. +- [`truncateMiddle( str, len, seq )`][@stdlib/string/base/truncate-middle]: truncate the middle UTF-16 code units of a string to return a string having a specified length. - [`uncapitalize( str )`][@stdlib/string/base/uncapitalize]: uncapitalize the first character of a string. - [`uppercase( str )`][@stdlib/string/base/uppercase]: convert a string to uppercase. @@ -156,6 +164,8 @@ str = ns.trim( str ); +[@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 @@ -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 @@ -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 diff --git a/base/distances/README.md b/base/distances/README.md index 3e70cdc4..778203fc 100644 --- a/base/distances/README.md +++ b/base/distances/README.md @@ -45,6 +45,7 @@ The namespace contains the following functions:
+- [`hammingDistance( s1, s2 )`][@stdlib/string/base/distances/hamming]: calculate the Hamming distance between two equal-length strings. - [`levenshteinDistance( s1, s2 )`][@stdlib/string/base/distances/levenshtein]: calculate the Levenshtein (edit) distance between two strings.
@@ -97,6 +98,8 @@ var dist = ns.levenshteinDistance( 'algorithm', 'altruistic' ); +[@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