feat!: Use TextEncoder to convert strings (#497)

Author: Jason3S

.github/workflows/test.yml

@@ -64,3 +64,29 @@ jobs:
 
       # Ensure the repository is clean after build & test
       - run: git --no-pager diff --compact-summary --exit-code
+
+  test-performance:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        node-version:
+          # Test the latest node version here, move older versions to `test-old-node-versions`
+          - 20.x
+
+        os:
+          - ubuntu-latest
+          # - windows-latest
+          # - macos-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - run: npm ci
+
+      - run: npm run insight

README.md

@@ -21,8 +21,7 @@ npm install --save js-xxhash
 
 ### Pure JS
 
-Uses an internal JS conversion of strings to a UTF-8 `Uint8Array`.
-For higher performance consider using dedicated converters in the examples for Node and Browser below.
+Internally it uses [TextEncoder](https://developer.mozilla.org/en-US/docs/Web/API/TextEncoder) to convert strings to a UTF-8 `Uint8Array`s.
 
 ```typescript
 import { xxHash32 } from 'js-xxhash';
@@ -46,23 +45,97 @@ import { xxHash32 } from 'js-xxhash';
 
 let seed = 0;
 let str = 'My text to hash 😊';
-let hashNum = xxHash32(Buffer.from(str, 'utf8'), seed);
+let hashNum = xxHash32(str, seed);
 console.log(hashNum.toString(16));
 ```
 
 ### Browser
 
-In a browser, you need to use a function or library to create a
-[`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
-
-Using [Browserify](http://browserify.org/) you can use it like this:
-
 ```typescript
+// Using a bundler
 import { xxHash32 } from 'js-xxhash';
+// Using a CDN like jsDelivr
+import { xxHash32 } from 'https://cdn.jsdelivr.net/npm/js-xxhash@{version}/index.mjs';
 
-let textEncoder = new TextEncoder(); // Note TextEncoder is experimental
 let seed = 0;
 let str = 'My text to hash 😊';
-let hashNum = xxHash32(textEncoder.encode(str), seed);
+let hashNum = xxHash32(str, seed);
 console.log(hashNum.toString(16));
 ```
+
+# Performance
+
+To evaluate performance this package was compared to:
+
+- [xxhashjs](https://www.npmjs.com/package/xxhashjs)
+- [xxhash-wasm](https://www.npmjs.com/package/xxhash-wasm)
+
+One average a lorem-ipsum "word" is between 5 and 6 characters.
+
+## Performance for Strings
+
+```
+Running Perf Suite: xxhash-string-words-10
+Evaluate xxhash performance with a string of 10 words.
+✔ js-xxhash string       731_148.14 ops/sec
+✔ xxhashjs string        432_753.87 ops/sec
+✔ xxhash-wasm string   3_381_907.91 ops/sec
+
+Running Perf Suite: xxhash-string-words-100
+Evaluate xxhash performance with a string of 100 words.
+✔ js-xxhash string       420_458.19 ops/sec
+✔ xxhashjs string        124_443.56 ops/sec
+✔ xxhash-wasm string   2_289_457.63 ops/sec
+
+Running Perf Suite: xxhash-string-words-1000
+Evaluate xxhash performance with a string of 1000 words.
+✔ js-xxhash string        74_861.33 ops/sec
+✔ xxhashjs string         16_656.57 ops/sec
+✔ xxhash-wasm string     729_339.20 ops/sec
+
+Running Perf Suite: xxhash-string-words-10000
+Evaluate xxhash performance with a string of 10000 words.
+✔ js-xxhash string         6_293.40 ops/sec
+✔ xxhashjs string            551.90 ops/sec
+✔ xxhash-wasm string      90_170.30 ops/sec
+
+Running Perf Suite: xxhash-string-words-100000
+Evaluate xxhash performance with a string of 100000 words.
+✔ js-xxhash string           709.30 ops/sec
+✔ xxhashjs string             40.05 ops/sec
+✔ xxhash-wasm string       8_093.17 ops/sec
+```
+
+### Performance with a Uint8Array Buffer
+
+```
+Running Perf Suite: xxhash-buffer-words-10
+Evaluate xxhash performance with a buffer containing a string of 10 words.
+✔ js-xxhash buffer       2_859_850.03 ops/sec
+✔ xxhashjs buffer          699_053.22 ops/sec
+✔ xxhash-wasm buffer     3_657_504.67 ops/sec
+
+Running Perf Suite: xxhash-buffer-words-100
+Evaluate xxhash performance with a buffer containing a string of 100 words.
+✔ js-xxhash buffer         800_609.77 ops/sec
+✔ xxhashjs buffer          402_424.91 ops/sec
+✔ xxhash-wasm buffer     2_569_294.66 ops/sec
+
+Running Perf Suite: xxhash-buffer-words-1000
+Evaluate xxhash performance with a buffer containing a string of 1000 words.
+✔ js-xxhash buffer         79_925.04 ops/sec
+✔ xxhashjs buffer          55_568.13 ops/sec
+✔ xxhash-wasm buffer      753_856.33 ops/sec
+
+Running Perf Suite: xxhash-buffer-words-10000
+Evaluate xxhash performance with a buffer containing a string of 10000 words.
+✔ js-xxhash buffer          8_152.57 ops/sec
+✔ xxhashjs buffer           6_046.82 ops/sec
+✔ xxhash-wasm buffer      104_463.50 ops/sec
+
+Running Perf Suite: xxhash-buffer-words-100000
+Evaluate xxhash performance with a buffer containing a string of 100000 words.
+✔ js-xxhash buffer            458.33 ops/sec
+✔ xxhashjs buffer             602.90 ops/sec
+✔ xxhash-wasm buffer        9_835.61 ops/sec
+```

index.mjs

@@ -0,0 +1 @@
+export { xxHash32 } from './dist/esm/index.js';