File tree 1 file changed +33
-1
lines changed
1 file changed +33
-1
lines changed Original file line number Diff line number Diff line change 2
2
3
3
A WebAssembly build of [ Rust Regex] ( https://docs.rs/regex/latest/regex/ ) for Javascript
4
4
5
+ ![ GitHub Actions Workflow Status] ( https://img.shields.io/github/actions/workflow/status/2fd/rregex/release.yml?branch=master ) ![ GitHub Release] ( https://img.shields.io/github/v/release/2fd/rregex ) ![ NPM Version] ( https://img.shields.io/npm/v/rregex )
6
+ ![ JSR Version] ( https://img.shields.io/jsr/v/%40rregex/rregex )
7
+
5
8
> Note: this project is not intended to be used in production jet
6
9
7
10
- [ Why Rust Regex] ( #why-rust-regex )
8
11
- [ Install] ( #install )
12
+ - [ Supported Runtimes] ( #supported-runtimes )
9
13
- [ API] ( https://tsdocs.dev/docs/rregex/latest )
10
14
- [ ` RRegex ` ] ( https://tsdocs.dev/docs/rregex/latest/classes/RRegex.html )
11
15
- [ ` RRegexSet ` ] ( https://tsdocs.dev/docs/rregex/latest/classes/RRegexSet.html )
@@ -23,9 +27,37 @@ Rust has a powerful Regex library with a lot of features that don't exists en th
23
27
## Install
24
28
25
29
``` bash
26
- npm install rregex
30
+ # NPM
31
+ npm install rregex
32
+
33
+ # Yarn
34
+ yarn add rregex
35
+
36
+ # PNPM
37
+ pnpm add rregex
38
+
39
+ # Deno
40
+ deno add @rregex/rregex
41
+
42
+ # JSR
43
+ npx jsr add @rregex/rregex
27
44
```
28
45
46
+ ## Supported Runtimes
47
+
48
+ This package includes builds for multiple runtimes
49
+
50
+ | Runtime | File |
51
+ | ------------------ | ----------------------------------------------- |
52
+ | Node.js (esm) | [ ` lib/esm.mjs ` (default)] ( ./test/node.test.mjs ) |
53
+ | Node.js (commonjs) | [ ` lib/commonjs.cjs ` ] ( ./test/node.test.cjs ) |
54
+ | Deno | [ ` lib/esm.mjs ` ] ( ./test/deno.test.mjs ) |
55
+ | Bun | [ ` lib/esm.mjs ` ] ( ./test/bun.test.mjs ) |
56
+ | Cloudflare Workers | TODO |
57
+ | Browser | TODO |
58
+ | Standalone | TODO |
59
+ | Typescript | ` lib/types.d.ts ` |
60
+
29
61
## Known Issues
30
62
31
63
If you call ` splitn(text, limit) ` and the expected result length is equal to ` limit - 1 ` the result will include an extra item ` "" ` , this behavior does not happen if ` limit ` es greater. ** ` fixed at >=1.3 ` **
You can’t perform that action at this time.
0 commit comments