https://github.com/napi-rs/fast-escape
Faster html escape
https://github.com/napi-rs/fast-escape
Last synced: about 1 year ago
JSON representation
Faster html escape
- Host: GitHub
- URL: https://github.com/napi-rs/fast-escape
- Owner: napi-rs
- License: mit
- Created: 2020-09-08T11:59:49.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2025-06-09T11:45:43.000Z (about 1 year ago)
- Last Synced: 2025-06-09T12:42:34.817Z (about 1 year ago)
- Language: JavaScript
- Size: 8.18 MB
- Stars: 26
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# `@napi-rs/fast-escape`
## Install this package
```
yarn add @napi-rs/fast-escape
```
## Performance
```
Model Name: MacBook Pro
Model Identifier: MacBookPro15,1
Processor Name: 6-Core Intel Core i9
Processor Speed: 2.9 GHz
Number of Processors: 1
Total Number of Cores: 6
L2 Cache (per Core): 256 KB
L3 Cache: 12 MB
Hyper-Threading Technology: Enabled
Memory: 32 GB
```
```js
napi x 799 ops/sec ±0.38% (93 runs sampled)
napi#buff x 980 ops/sec ±1.39% (92 runs sampled)
napi#asyncBuff x 805 ops/sec ±1.33% (75 runs sampled)
javascript x 586 ops/sec ±1.40% (81 runs sampled)
Escape html benchmark # Large input bench suite: Fastest is napi#buff
napi x 2,158,169 ops/sec ±0.59% (93 runs sampled)
napi#buff x 2,990,077 ops/sec ±0.73% (93 runs sampled)
napi#asyncBuff x 66,540 ops/sec ±3.02% (77 runs sampled)
javascript x 1,951,484 ops/sec ±0.31% (92 runs sampled)
Escape html benchmark # Small input bench suite: Fastest is napi#buff
```
## Develop requirements
- Install latest `Rust`
- Install `NodeJS@10+` which supports `N-API`
- Install `yarn@1.x`
## Test in local
- `yarn`
- `yarn build`
- `yarn test`
And you will see:
```bash
$ ava --verbose
✔ escape html
─
1 test passed
✨ Done in 1.47s.
```
## Release package
Ensure you have set you **NPM_TOKEN** in `Github` project setting.
In `Settings -> Secrets`, add **NPM_TOKEN** into it.
When you want release package:
```
yarn version [xxx]
git push --follow-tags
```
Github actions will do the rest job for you.