Auto-generated commit

README.md

@@ -92,6 +92,7 @@ The namespace exposes the following string manipulation functions:
 -   <span class="signature">[`fromCodePoint( pt1[, pt2[, pt3[, ...]]] )`][@stdlib/string/from-code-point]</span><span class="delimiter">: </span><span class="description">create a string from a sequence of Unicode code points.</span>
 -   <span class="signature">[`headercase( str )`][@stdlib/string/headercase]</span><span class="delimiter">: </span><span class="description">convert a string to HTTP header case.</span>
 -   <span class="signature">[`kebabcase( str )`][@stdlib/string/kebabcase]</span><span class="delimiter">: </span><span class="description">convert a string to kebab case.</span>
+-   <span class="signature">[`last( str[, n][, options] )`][@stdlib/string/last]</span><span class="delimiter">: </span><span class="description">return the last character(s) of a string.</span>
 -   <span class="signature">[`lpad( str, len[, pad] )`][@stdlib/string/left-pad]</span><span class="delimiter">: </span><span class="description">left pad a string.</span>
 -   <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>
@@ -126,6 +127,7 @@ The namespace exposes the following string manipulation functions:
 -   <span class="signature">[`substringBefore( str, search )`][@stdlib/string/substring-before]</span><span class="delimiter">: </span><span class="description">return the part of a string before a specified substring.</span>
 -   <span class="signature">[`graphemeClusters2iteratorRight( src[, mapFcn[, thisArg]] )`][@stdlib/string/to-grapheme-cluster-iterator-right]</span><span class="delimiter">: </span><span class="description">create an iterator which iterates from right to left over grapheme clusters.</span>
 -   <span class="signature">[`graphemeClusters2iterator( src[, mapFcn[, thisArg]] )`][@stdlib/string/to-grapheme-cluster-iterator]</span><span class="delimiter">: </span><span class="description">create an iterator which iterates over grapheme clusters.</span>
+-   <span class="signature">[`toWellFormed( str )`][@stdlib/string/to-well-formed]</span><span class="delimiter">: </span><span class="description">create a new well-formed string.</span>
 -   <span class="signature">[`trim( str )`][@stdlib/string/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/truncate-middle]</span><span class="delimiter">: </span><span class="description">truncate a string in the middle to a specified length.</span>
 -   <span class="signature">[`truncate( str, len[, ending] )`][@stdlib/string/truncate]</span><span class="delimiter">: </span><span class="description">truncate a string to a specified length.</span>
@@ -270,6 +272,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 [@stdlib/string/kebabcase]: https://github.com/stdlib-js/string/tree/main/kebabcase
 
+[@stdlib/string/last]: https://github.com/stdlib-js/string/tree/main/last
+
 [@stdlib/string/left-pad]: https://github.com/stdlib-js/string/tree/main/left-pad
 
 [@stdlib/string/left-trim-n]: https://github.com/stdlib-js/string/tree/main/left-trim-n
@@ -338,6 +342,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 [@stdlib/string/to-grapheme-cluster-iterator]: https://github.com/stdlib-js/string/tree/main/to-grapheme-cluster-iterator
 
+[@stdlib/string/to-well-formed]: https://github.com/stdlib-js/string/tree/main/to-well-formed
+
 [@stdlib/string/trim]: https://github.com/stdlib-js/string/tree/main/trim
 
 [@stdlib/string/truncate-middle]: https://github.com/stdlib-js/string/tree/main/truncate-middle

base/README.md

@@ -56,6 +56,7 @@ The namespace contains the following functions:
 -   <span class="signature">[`firstCodePoint( str, n )`][@stdlib/string/base/first-code-point]</span><span class="delimiter">: </span><span class="description">return the first `n` Unicode code points of a string.</span>
 -   <span class="signature">[`firstGraphemeCluster( str, n )`][@stdlib/string/base/first-grapheme-cluster]</span><span class="delimiter">: </span><span class="description">return the first `n` grapheme clusters (i.e., user-perceived characters) of a string.</span>
 -   <span class="signature">[`first( str, n )`][@stdlib/string/base/first]</span><span class="delimiter">: </span><span class="description">return the first `n` UTF-16 code units of a string.</span>
+-   <span class="signature">[`forEachCodePointRight( str, clbk[, thisArg ] )`][@stdlib/string/base/for-each-code-point-right]</span><span class="delimiter">: </span><span class="description">invokes a function for each Unicode code point in a string, iterating from right to left.</span>
 -   <span class="signature">[`forEachCodePoint( str, clbk[, thisArg ] )`][@stdlib/string/base/for-each-code-point]</span><span class="delimiter">: </span><span class="description">invokes a function for each Unicode code point in a string.</span>
 -   <span class="signature">[`forEachGraphemeCluster( str, clbk[, thisArg ] )`][@stdlib/string/base/for-each-grapheme-cluster]</span><span class="delimiter">: </span><span class="description">invokes a function for each grapheme cluster (i.e., user-perceived character) in a string.</span>
 -   <span class="signature">[`forEachRight( str, clbk[, thisArg ] )`][@stdlib/string/base/for-each-right]</span><span class="delimiter">: </span><span class="description">invokes a function for each UTF-16 code unit in a string, iterating from right to left.</span>
@@ -65,6 +66,9 @@ The namespace contains the following functions:
 -   <span class="signature">[`headercase( str )`][@stdlib/string/base/headercase]</span><span class="delimiter">: </span><span class="description">convert a string to HTTP header case.</span>
 -   <span class="signature">[`invcase( str )`][@stdlib/string/base/invcase]</span><span class="delimiter">: </span><span class="description">convert a string to inverse case.</span>
 -   <span class="signature">[`kebabcase( str )`][@stdlib/string/base/kebabcase]</span><span class="delimiter">: </span><span class="description">convert a string to kebab case.</span>
+-   <span class="signature">[`lastCodePoint( str, n )`][@stdlib/string/base/last-code-point]</span><span class="delimiter">: </span><span class="description">return the last `n` Unicode code points of a string.</span>
+-   <span class="signature">[`lastGraphemeCluster( str, n )`][@stdlib/string/base/last-grapheme-cluster]</span><span class="delimiter">: </span><span class="description">return the last `n` grapheme clusters (i.e., user-perceived characters) of a string.</span>
+-   <span class="signature">[`last( str, n )`][@stdlib/string/base/last]</span><span class="delimiter">: </span><span class="description">return the last `n` UTF-16 code units of a string.</span>
 -   <span class="signature">[`lpad( str, len, pad )`][@stdlib/string/base/left-pad]</span><span class="delimiter">: </span><span class="description">left pad a string.</span>
 -   <span class="signature">[`ltrim( str )`][@stdlib/string/base/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/base/lowercase]</span><span class="delimiter">: </span><span class="description">convert a string to lowercase.</span>
@@ -90,6 +94,7 @@ The namespace contains the following functions:
 -   <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">[`stickycase( str[, p] )`][@stdlib/string/base/stickycase]</span><span class="delimiter">: </span><span class="description">convert a string to sticky case.</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>
@@ -190,6 +195,8 @@ str = ns.trim( str );
 
 [@stdlib/string/base/first]: https://github.com/stdlib-js/string/tree/main/base/first
 
+[@stdlib/string/base/for-each-code-point-right]: https://github.com/stdlib-js/string/tree/main/base/for-each-code-point-right
+
 [@stdlib/string/base/for-each-code-point]: https://github.com/stdlib-js/string/tree/main/base/for-each-code-point
 
 [@stdlib/string/base/for-each-grapheme-cluster]: https://github.com/stdlib-js/string/tree/main/base/for-each-grapheme-cluster
@@ -208,6 +215,12 @@ str = ns.trim( str );
 
 [@stdlib/string/base/kebabcase]: https://github.com/stdlib-js/string/tree/main/base/kebabcase
 
+[@stdlib/string/base/last-code-point]: https://github.com/stdlib-js/string/tree/main/base/last-code-point
+
+[@stdlib/string/base/last-grapheme-cluster]: https://github.com/stdlib-js/string/tree/main/base/last-grapheme-cluster
+
+[@stdlib/string/base/last]: https://github.com/stdlib-js/string/tree/main/base/last
+
 [@stdlib/string/base/left-pad]: https://github.com/stdlib-js/string/tree/main/base/left-pad
 
 [@stdlib/string/base/left-trim]: https://github.com/stdlib-js/string/tree/main/base/left-trim
@@ -258,6 +271,8 @@ str = ns.trim( str );
 
 [@stdlib/string/base/starts-with]: https://github.com/stdlib-js/string/tree/main/base/starts-with
 
+[@stdlib/string/base/stickycase]: https://github.com/stdlib-js/string/tree/main/base/stickycase
+
 [@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