Package Exports

@stdlib/string
@stdlib/string/capitalize
@stdlib/string/code-point-at
@stdlib/string/ends-with
@stdlib/string/from-code-point
@stdlib/string/left-pad
@stdlib/string/left-trim
@stdlib/string/lowercase
@stdlib/string/next-grapheme-cluster-break
@stdlib/string/num-grapheme-clusters
@stdlib/string/pad
@stdlib/string/percent-encode
@stdlib/string/remove-first
@stdlib/string/remove-last
@stdlib/string/remove-punctuation
@stdlib/string/remove-utf8-bom
@stdlib/string/remove-words
@stdlib/string/repeat
@stdlib/string/replace
@stdlib/string/reverse
@stdlib/string/right-pad
@stdlib/string/right-trim
@stdlib/string/startcase
@stdlib/string/starts-with
@stdlib/string/trim
@stdlib/string/uncapitalize
@stdlib/string/uppercase
@stdlib/string/utf16-to-utf8-array

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/string) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

String Manipulation

Standard library string manipulation functions.

Installation

npm install @stdlib/string

Usage

var string = require( '@stdlib/string' );

string

Standard library string manipulation functions.

var str = string;
// returns {...}

The namespace exposes the following string manipulation functions:

capitalize( str ): capitalize the first character in a string.
codePointAt( string, position[, backward] ): return a Unicode code point from a string at a specified position.
endsWith( str, search[, len] ): test if a string ends with the characters of another string.
fromCodePoint( pt1[, pt2[, pt3[, ...]]] ): create a string from a sequence of Unicode code points.
lpad( str, len[, pad] ): left pad a string.
ltrim( str ): trim whitespace characters from the beginning of a string.
lowercase( str ): convert a string to lowercase.
nextGraphemeClusterBreak( string[, fromIndex] ): return the next extended grapheme cluster break in a string after a specified position.
numGraphemeClusters( str ): return the number of grapheme clusters in a string.
pad( str, len[, options] ): pad a string.
percentEncode( str ): percent-encode a UTF-16 encoded string according to RFC 3986.
removeFirst( str ): remove the first character of a string.
removeLast( str ): remove the last character of a string.
removePunctuation( str ): remove punctuation characters from a string.
removeUTF8BOM( str ): remove a UTF-8 byte order mark (BOM) from the beginning of a string.
removeWords( str, words[, ignoreCase] ): remove a list of words from a string.
repeat( str, n ): repeat a string a specified number of times and return the concatenated result.
replace( str, search, newval ): replace search occurrences with a replacement string.
reverseString( str ): reverse a string.
rpad( str, len[, pad] ): right pad a string.
rtrim( str ): trim whitespace characters from the end of a string.
startcase( str ): capitalize the first letter of each word in a string.
startsWith( str, search[, position] ): test if a string starts with the characters of another string.
trim( str ): trim whitespace characters from the beginning and end of a string.
uncapitalize( str ): uncapitalize the first character of a string.
uppercase( str ): convert a string to uppercase.
utf16ToUTF8Array( str ): convert a UTF-16 encoded string to an array of integers using UTF-8 encoding.

Examples

var getKeys = require( '@stdlib/utils/keys' );
var string = require( '@stdlib/string' );

console.log( getKeys( string ) );

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

License

See LICENSE.

@stdlib/string