Repository files navigation

A dependency-free WebAssembly build ofRust Regex for Javascript

• Why Rust Regex
• Install
• Supported Runtimes
• API
  • RRegex
  • RRegexSet
  • Match
  • Captures
  • escape
• Benchmarks
• Known Issues

Rust has a powerful Regex library with a lot of features that don't exists en the standardRegex object

See the official documentation for more detail

# NPM  npm install rregex# Yarn  yarn add rregex# PNPM  pnpm add rregex# Deno  deno add @rregex/rregex# JSR  npx jsr add @rregex/rregex

This package includes builds for multiple runtimes

In general termsrregex is at least 1 order of magnitud slower than the nativeRegExp object, but still have a good performance.Unless you required some of the features thatrregex provides, you should always consider using the nativeRegExp object

Benchmarks are executed usingtest/deno.bench.mjs, andtest/node.bench.mjs

summary:RegExp is 21.19x faster thanRRegex

summary:RegExp is 96.59x faster thanRRegex

summary:RegExp is 32689.42x faster thanRRegex

benckmarks	benckmarks

Note: In order to compare with native regex these benchmarks follow themariomka/regex-benchmark structure

If you callsplitn(text, limit) and the expected result length is equal tolimit - 1 the result will include an extra item"", this behavior does not happen iflimit es greater.fixed at >=1.3

constregex=newRRegex(",");expect(regex.splitn("a,b,c",0)).toEqual([]);expect(regex.splitn("a,b,c",1)).toEqual(["a,b,c"]);expect(regex.splitn("a,b,c",2)).toEqual(["a","b,c"]);expect(regex.splitn("a,b,c",3)).toEqual(["a","b","c"]);// This result includes an unexpected extra itemexpect(regex.splitn("a,b,c",4)).toEqual(["a","b","c",""]);expect(regex.splitn("a,b,c",5)).toEqual(["a","b","c"]);expect(regex.splitn("abc",0)).toEqual([]);expect(regex.splitn("abc",1)).toEqual(["abc"]);// This result includes an unexpected extra itemexpect(regex.splitn("abc",2)).toEqual(["abc",""]);expect(regex.splitn("abc",3)).toEqual(["abc"]);