Skip to content

Namespace String

String utilities for validation, formatting, transformation, and parsing.

Install

Use this namespace only:

bash
npm i @litert/utils-string

Or install the full bundle:

bash
npm i @litert/utils

And then import from it.

ts
import * as LibUtils from '@litert/utils';
LibUtils.String.nameCase(str);

// or
import { String as LibString } from '@litert/utils';
LibString.nameCase(str);

Exports

Classes

NameDescription
UnitParserExtracts a numeric value and a unit name from a string using a configurable format.

Functions

NameDescription
includeEvilWhitespaceCharsChecks if a string contains invisible "evil" whitespace characters.
replaceEvilWhitespaceCharsReplaces invisible "evil" whitespace characters.
includeEvilSpaceChars⚠️ Deprecated alias for includeEvilWhitespaceChars.
replaceEvilSpaceChars⚠️ Deprecated alias for replaceEvilWhitespaceChars.
htmlEscapeEscapes HTML special characters in a string.
isEmailAddressValidates an email address string.
splitIntoLinesSplits a string by EOL characters into an array of lines.
toUnixStringConverts all line endings to Unix-style (\n).
toWindowsStringConverts all line endings to Windows-style (\r\n).
toMacStringConverts all line endings to Mac-style (\r).
isUpperSnakeCaseChecks if a string is in UPPER_SNAKE_CASE format.
isLowerSnakeCaseChecks if a string is in lower_snake_case format.
isUpperCamelCaseChecks if a string is in UpperCamelCase format.
isPascalCaseAlias for isUpperCamelCase. Checks PascalCase format.
isLowerCamelCaseChecks if a string is in lowerCamelCase format.
randomGenerates a random string of specified length from a charset.
regexpEscapeEscapes special characters for use inside a RegExp.
toChunksSplits a string into equal-sized chunks (left to right).
toChunksBackwardSplits a string into equal-sized chunks (right to left).

Constants

NameDescription
ERandomStringCharsetEnum of predefined character sets for random string generation.
DEFAULT_RANDOM_CHARSETDefault charset combining upper/lower alpha and digits.

Typings

NameDescription
IEmailValidationOptionsOptions for the isEmailAddress function.
IUnitInfoOptions for a single unit in UnitParser.
IUnitParserOptionsConstructor options for UnitParser.
IUnitParserResultReturn type of UnitParser.parse().