xxhash-wasm 项目使用教程

xxhash-wasm 项目使用教程

xxhash-wasm A WebAssembly implementation of xxHash 项目地址: https://gitcode.com/gh_mirrors/xx/xxhash-wasm

1. 项目的目录结构及介绍

xxhash-wasm/
├── dist/
│   ├── xxhash-wasm.js
│   ├── xxhash-wasm.min.js
│   ├── xxhash-wasm.wasm
│   └── xxhash-wasm.worker.js
├── src/
│   ├── xxhash.js
│   ├── xxhash.wasm
│   └── xxhash.worker.js
├── test/
│   ├── index.js
│   └── test.js
├── package.json
├── README.md
└── LICENSE

• dist/: 包含编译后的文件，包括 JavaScript 文件、WebAssembly 文件和 Web Worker 文件。
• src/: 包含项目的源代码，包括主要的 JavaScript 文件、WebAssembly 文件和 Web Worker 文件。
• test/: 包含项目的测试文件，用于测试 xxhash-wasm 的功能。
• package.json: 项目的配置文件，包含项目的依赖、脚本等信息。
• README.md: 项目的说明文档，包含项目的介绍、使用方法等。
• LICENSE: 项目的许可证文件。

2. 项目的启动文件介绍

项目的启动文件是 src/xxhash.js，该文件是 xxhash-wasm 的主要入口文件。它负责加载 WebAssembly 模块并提供 API 供 JavaScript 调用。

import xxhash from "xxhash-wasm";

xxhash().then(hasher => {
  const input = "The string that is being hashed";
  const hash32 = hasher.h32(input); // 3998627172 (decimal representation)
  const hash32Hex = hasher.h32ToString(input); // "ee563564"
  const hash64 = hasher.h64(input); // 5776724552493396044n (BigInt)
  const hash64Hex = hasher.h64ToString(input); // "502b0c5fc4a5704c"
});

3. 项目的配置文件介绍

项目的配置文件是 package.json，该文件包含了项目的元数据、依赖项、脚本等信息。

{
  "name": "xxhash-wasm",
  "version": "1.0.2",
  "description": "A WebAssembly implementation of xxHash, a fast non-cryptographic hash algorithm.",
  "main": "dist/xxhash-wasm.js",
  "module": "dist/xxhash-wasm.esm.js",
  "types": "dist/xxhash-wasm.d.ts",
  "scripts": {
    "build": "rollup -c",
    "test": "jest"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/jungomi/xxhash-wasm.git"
  },
  "keywords": [
    "xxhash",
    "webassembly",
    "wasm",
    "hash",
    "non-cryptographic"
  ],
  "author": "jungomi",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/jungomi/xxhash-wasm/issues"
  },
  "homepage": "https://github.com/jungomi/xxhash-wasm#readme",
  "devDependencies": {
    "jest": "^26.6.3",
    "rollup": "^2.35.1",
    "rollup-plugin-terser": "^7.0.2"
  }
}

• name: 项目的名称。
• version: 项目的版本号。
• description: 项目的描述。
• main: 项目的入口文件。
• module: 项目的 ES 模块入口文件。
• types: 项目的 TypeScript 类型定义文件。
• scripts: 项目的脚本命令，例如 build 用于构建项目，test 用于运行测试。
• repository: 项目的代码仓库信息。
• keywords: 项目的关键词。
• author: 项目的作者。
• license: 项目的许可证。
• bugs: 项目的 Bug 跟踪地址。
• homepage: 项目的主页地址。
• devDependencies: 项目的开发依赖。

xxhash-wasm A WebAssembly implementation of xxHash 项目地址: https://gitcode.com/gh_mirrors/xx/xxhash-wasm