Documentation Index
Fetch the complete documentation index at: https://mintlify.com/fajarnugraha37/ts-rex/llms.txt
Use this file to discover all available pages before exploring further.
TS-Rex provides a method for every JavaScript character class and escape sequence, so you can express any character-matching pattern through a readable, composable builder chain rather than raw regex syntax. Every method returns a new RegexBuilder instance — the original is never mutated.
Common character classes
These methods map directly to JavaScript’s standard regex character class tokens.
anyChar()
anyChar(): RegexBuilder<TCaptures, TFlags>
..
import { rx } from '@fajarnugraha37/ts-rex';
const pattern = rx().anyChar().compile();
pattern.exec('a').isMatch; // true
pattern.exec('\n').isMatch; // false — line terminators are excluded
To match newlines as well, chain .dotAll() before .compile(). This sets the s flag, which makes . match every character including \n.
digit()
digit(): RegexBuilder<TCaptures, TFlags>
\d.
const pattern = rx().oneOrMore(rx().digit()).compile();
pattern.exec('42').match; // "42"
pattern.exec('abc').isMatch; // false
notDigit()
notDigit(): RegexBuilder<TCaptures, TFlags>
\D.
const pattern = rx().oneOrMore(rx().notDigit()).compile();
pattern.exec('abc').match; // "abc"
wordChar()
wordChar(): RegexBuilder<TCaptures, TFlags>
[a-zA-Z0-9_]). Maps to \w.
const pattern = rx()
.capture('name', rx().oneOrMore(rx().wordChar()))
.compile();
const result = pattern.exec('hello_world');
if (result.isMatch) {
result.name; // "hello_world"
}
notWordChar()
notWordChar(): RegexBuilder<TCaptures, TFlags>
\W.
const pattern = rx().notWordChar().compile();
pattern.exec(' ').isMatch; // true
pattern.exec('a').isMatch; // false
whitespace()
whitespace(): RegexBuilder<TCaptures, TFlags>
\s.
const pattern = rx()
.capture('first', rx().oneOrMore(rx().wordChar()))
.whitespace()
.capture('second', rx().oneOrMore(rx().wordChar()))
.compile();
const result = pattern.exec('foo bar');
if (result.isMatch) {
result.first; // "foo"
result.second; // "bar"
}
notWhitespace()
notWhitespace(): RegexBuilder<TCaptures, TFlags>
\S.
const pattern = rx().oneOrMore(rx().notWhitespace()).compile();
pattern.exec('hello world').match; // "hello"
Character sets
Use these methods to match or exclude an explicit set of characters, or to match characters within a contiguous range.
anyOf(chars)
anyOf(chars: string): RegexBuilder<TCaptures, TFlags>
chars. Maps to [...].
A string of characters to include in the character class. Special regex characters are automatically escaped.
const pattern = rx().anyOf('aeiou').compile();
pattern.exec('hello').match; // "e"
anyOf auto-escapes all characters in the input string. Passing 'a-z' does not create a range — it matches the literal characters a, -, and z. Use .range('a', 'z') to match a contiguous range.
noneOf(chars)
noneOf(chars: string): RegexBuilder<TCaptures, TFlags>
chars. Maps to [^...]. The chars string is auto-escaped identically to anyOf.
A string of characters to exclude. Special regex characters are automatically escaped.
const pattern = rx().oneOrMore(rx().noneOf('0123456789')).compile();
pattern.exec('abc123').match; // "abc"
range(start, end)
range(start: string, end: string): RegexBuilder<TCaptures, TFlags>
[start, end] (inclusive). Maps to [start-end]. Both arguments must be exactly one character.
The first character in the range. Must be a single character.
The last character in the range. Must be a single character.
const lowercase = rx().range('a', 'z');
const uppercase = rx().range('A', 'Z');
const digits = rx().range('0', '9');
// Compose ranges with .or() to build complex classes safely
const alphanumeric = lowercase
.or(uppercase)
.or(digits);
const pattern = rx()
.capture('slug', rx().oneOrMore(alphanumeric))
.compile();
To combine multiple ranges into a single character class (equivalent to [a-zA-Z0-9]), chain them with .or(). The library compiles this to a nested alternation that behaves identically to the combined class.
Named control characters
These methods let you insert control characters into your pattern by name, avoiding hard-to-read escape sequences in source code.
nullChar()
nullChar(): RegexBuilder<TCaptures, TFlags>
\0.
const pattern = rx().nullChar().compile();
newline()
newline(): RegexBuilder<TCaptures, TFlags>
\n.
const pattern = rx()
.oneOrMore(rx().notWhitespace())
.newline()
.compile();
carriageReturn()
carriageReturn(): RegexBuilder<TCaptures, TFlags>
\r.
// Match Windows-style line endings
const crlf = rx().carriageReturn().newline().compile();
tab()
tab(): RegexBuilder<TCaptures, TFlags>
\t.
// Match tab-separated values
const pattern = rx()
.capture('key', rx().oneOrMore(rx().wordChar()))
.tab()
.capture('value', rx().oneOrMore(rx().notWhitespace()))
.compile();
verticalTab()
verticalTab(): RegexBuilder<TCaptures, TFlags>
\v.
const pattern = rx().verticalTab().compile();
formFeed(): RegexBuilder<TCaptures, TFlags>
\f.
const pattern = rx().formFeed().compile();
controlChar(char)
controlChar(char: string): RegexBuilder<TCaptures, TFlags>
controlChar('M') matches Ctrl-M (U+000D, same as \r). Maps to \cX where X is the uppercase letter.
A single ASCII letter A–Z (case-insensitive). Any other value throws an error.
// Match Ctrl-M (carriage return)
const pattern = rx().controlChar('M').compile();
Unicode and hex escapes
These methods let you target characters by numeric code point, Unicode category, or Unicode property.
hex(nn)
hex(nn: string): RegexBuilder<TCaptures, TFlags>
\xNN.
A 2-digit hexadecimal string (e.g., '41' for A). Throws if the string is not exactly two hex digits.
// Match the letter 'A' via its hex code 0x41
const pattern = rx().hex('41').compile();
pattern.exec('A').isMatch; // true
unicodeChar(nnnn)
unicodeChar(nnnn: string): RegexBuilder<TCaptures, TFlags>
\uNNNN.
A 4-digit hexadecimal string (e.g., '0041' for A). Throws if the string is not exactly four hex digits.
// Match the copyright symbol ©
const pattern = rx().unicodeChar('00A9').compile();
pattern.exec('©').isMatch; // true
unicodeCodePoint(nnnn)
unicodeCodePoint(nnnn: string): RegexBuilder<TCaptures, TFlags>
\u{NNNN}. Requires the u or v flag to be active.
A 1-to-6-digit hexadecimal string representing the code point (e.g., '1F600' for 😀). Throws if the string is not a valid hex sequence of 1–6 digits.
// Match the grinning face emoji
const pattern = rx()
.unicodeCodePoint('1F600')
.unicode()
.compile();
pattern.exec('😀').isMatch; // true
unicodeProperty(prop)
unicodeProperty(prop: string): RegexBuilder<TCaptures, TFlags>
\p{P}. Requires the u or v flag.
A Unicode property name or value (e.g., 'Letter', 'Script=Greek', 'Emoji').
// Match any Unicode letter
const pattern = rx()
.oneOrMore(rx().unicodeProperty('Letter'))
.unicode()
.compile();
pattern.exec('café').match; // "café"
notUnicodeProperty(prop)
notUnicodeProperty(prop: string): RegexBuilder<TCaptures, TFlags>
\P{P}. Requires the u or v flag.
A Unicode property name or value.
// Match any character that is not an ASCII digit
const pattern = rx()
.oneOrMore(rx().notUnicodeProperty('ASCII_Hex_Digit'))
.unicode()
.compile();
