# Base String > Base (i.e., lower-level) string functions.
## Usage ```javascript var string = require( '@stdlib/string/base' ); ``` #### string Namespace containing "base" (i.e., lower-level) string functions. ```javascript var ns = string; // returns {...} ``` 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. - [`constantcase( str )`][@stdlib/string/base/constantcase]: convert a string to constant case. - [`distances`][@stdlib/string/base/distances]: implementations of various string similarity metrics. - [`dotcase( str )`][@stdlib/string/base/dotcase]: convert a string to dot case. - [`endsWith( str, search, len )`][@stdlib/string/base/ends-with]: test if a string ends with the characters of another string. - [`firstCodePoint( str, n )`][@stdlib/string/base/first-code-point]: return the first `n` Unicode code points of a string. - [`firstGraphemeCluster( str, n )`][@stdlib/string/base/first-grapheme-cluster]: return the first `n` grapheme clusters (i.e., user-perceived characters) of a string. - [`first( str, n )`][@stdlib/string/base/first]: return the first `n` UTF-16 code units of a string. - [`forEachCodePointRight( str, clbk[, thisArg ] )`][@stdlib/string/base/for-each-code-point-right]: invokes a function for each Unicode code point in a string, iterating from right to left. - [`forEachCodePoint( str, clbk[, thisArg ] )`][@stdlib/string/base/for-each-code-point]: invokes a function for each Unicode code point in a string. - [`forEachGraphemeCluster( str, clbk[, thisArg ] )`][@stdlib/string/base/for-each-grapheme-cluster]: invokes a function for each grapheme cluster (i.e., user-perceived character) in a string. - [`forEachRight( str, clbk[, thisArg ] )`][@stdlib/string/base/for-each-right]: invokes a function for each UTF-16 code unit in a string, iterating from right to left. - [`forEach( str, clbk[, thisArg ] )`][@stdlib/string/base/for-each]: invokes a function for each UTF-16 code unit in a string. - [`formatInterpolate( tokens, ...args )`][@stdlib/string/base/format-interpolate]: generate string from a token array by interpolating values. - [`formatTokenize( str )`][@stdlib/string/base/format-tokenize]: tokenize a string into an array of string parts and format identifier objects. - [`headercase( str )`][@stdlib/string/base/headercase]: convert a string to HTTP header case. - [`invcase( str )`][@stdlib/string/base/invcase]: convert a string to inverse case. - [`kebabcase( str )`][@stdlib/string/base/kebabcase]: convert a string to kebab case. - [`lastCodePoint( str, n )`][@stdlib/string/base/last-code-point]: return the last `n` Unicode code points of a string. - [`lastGraphemeCluster( str, n )`][@stdlib/string/base/last-grapheme-cluster]: return the last `n` grapheme clusters (i.e., user-perceived characters) of a string. - [`last( str, n )`][@stdlib/string/base/last]: return the last `n` UTF-16 code units of a string. - [`lpad( str, len, pad )`][@stdlib/string/base/left-pad]: left pad a string. - [`ltrim( str )`][@stdlib/string/base/left-trim]: trim whitespace characters from the beginning of a string. - [`lowercase( str )`][@stdlib/string/base/lowercase]: convert a string to lowercase. - [`pascalcase( str )`][@stdlib/string/base/pascalcase]: convert a string to Pascal case. - [`percentEncode( str )`][@stdlib/string/base/percent-encode]: percent-encode a UTF-16 encoded string according to RFC 3986. - [`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. - [`replaceAfterLast( str, search, replacement, fromIndex )`][@stdlib/string/base/replace-after-last]: replace the substring after the last occurrence of a specified search string. - [`replaceAfter( str, search, replacement, fromIndex )`][@stdlib/string/base/replace-after]: replace the substring after the first occurrence of a specified search string. - [`replaceBeforeLast( str, search, replacement, fromIndex )`][@stdlib/string/base/replace-before-last]: replace the substring before the last occurrence of a specified search string. - [`replaceBefore( str, search, replacement, fromIndex )`][@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. - [`stickycase( str[, p] )`][@stdlib/string/base/stickycase]: convert a string to sticky case. - [`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.
## Examples ```javascript var ns = require( '@stdlib/string/base' ); // Generate a Pascal case string... var str = ns.pascalcase( 'beep boop' ); // returns 'BeepBoop' // Tokenize a string into an array of string parts and format identifier objects... str = 'The %d %s foxes jumped over the %d %s dogs.'; var tokens = ns.formatTokenize( str ); // returns [ 'The ', {...}, ' ', {...}, ' foxes jumped over the ', {...}, ' ', {...}, ' dogs.' ] // Generate a string from a token array by interpolating values... str = ns.formatInterpolate( tokens, 3, 'quick', 4, 'lazy' ); // returns 'The 3 quick foxes jumped over the 4 lazy dogs.' // Test whether a string starts with the characters of another string... str = 'Lorem ipsum dolor sit amet'; var bool = ns.startsWith( str, 'Lorem' ); // returns true // Test whether a string ends with the characters of another string... bool = ns.endsWith( str, 'amet' ); // returns true // Trim whitespace characters from the beginning and end of a string... str = ' \t\n Lorem ipsum dolor sit amet \n\t '; str = ns.trim( str ); // returns 'Lorem ipsum dolor sit amet' ```
[@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 [@stdlib/string/base/code-point-at]: https://github.com/stdlib-js/string/tree/main/base/code-point-at [@stdlib/string/base/constantcase]: https://github.com/stdlib-js/string/tree/main/base/constantcase [@stdlib/string/base/distances]: https://github.com/stdlib-js/string/tree/main/base/distances [@stdlib/string/base/dotcase]: https://github.com/stdlib-js/string/tree/main/base/dotcase [@stdlib/string/base/ends-with]: https://github.com/stdlib-js/string/tree/main/base/ends-with [@stdlib/string/base/first-code-point]: https://github.com/stdlib-js/string/tree/main/base/first-code-point [@stdlib/string/base/first-grapheme-cluster]: https://github.com/stdlib-js/string/tree/main/base/first-grapheme-cluster [@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 [@stdlib/string/base/for-each-right]: https://github.com/stdlib-js/string/tree/main/base/for-each-right [@stdlib/string/base/for-each]: https://github.com/stdlib-js/string/tree/main/base/for-each [@stdlib/string/base/format-interpolate]: https://github.com/stdlib-js/string/tree/main/base/format-interpolate [@stdlib/string/base/format-tokenize]: https://github.com/stdlib-js/string/tree/main/base/format-tokenize [@stdlib/string/base/headercase]: https://github.com/stdlib-js/string/tree/main/base/headercase [@stdlib/string/base/invcase]: https://github.com/stdlib-js/string/tree/main/base/invcase [@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 [@stdlib/string/base/lowercase]: https://github.com/stdlib-js/string/tree/main/base/lowercase [@stdlib/string/base/pascalcase]: https://github.com/stdlib-js/string/tree/main/base/pascalcase [@stdlib/string/base/percent-encode]: https://github.com/stdlib-js/string/tree/main/base/percent-encode [@stdlib/string/base/remove-first-code-point]: https://github.com/stdlib-js/string/tree/main/base/remove-first-code-point [@stdlib/string/base/remove-first-grapheme-cluster]: https://github.com/stdlib-js/string/tree/main/base/remove-first-grapheme-cluster [@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-after-last]: https://github.com/stdlib-js/string/tree/main/base/replace-after-last [@stdlib/string/base/replace-after]: https://github.com/stdlib-js/string/tree/main/base/replace-after [@stdlib/string/base/replace-before-last]: https://github.com/stdlib-js/string/tree/main/base/replace-before-last [@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 [@stdlib/string/base/snakecase]: https://github.com/stdlib-js/string/tree/main/base/snakecase [@stdlib/string/base/startcase]: https://github.com/stdlib-js/string/tree/main/base/startcase [@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 [@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