中文文档

Hash-worker is a library for fast calculation of file hashes. It is based on hash-wasm and utilizes WebWorkers for parallel computation, which speeds up computation when processing file blocks.

Hash-worker supports two hash computation algorithms: MD5 and CRC32.

Both browser and node.js are supported.

Unit testing using Jest achieved 97% line coverage.

$ yarn add hash-worker
# or
$ npm install hash-worker

<script src="https://unpkg.com/hash-worker/dist/global.js"></script>
<script>
  HashWorker.getFileHashChunks()
</script>

import { getFileHashChunks, destroyWorkerPool, HashChksRes, HashChksParam } from 'hash-worker'

function handleGetHash(file: File) {
  const param: HashChksParam = {
    file: file,
    config: {
      workerCount: 8,
      strategy: Strategy.md5
    }
  }

  getFileHashChunks(param).then((data: HashChksRes) => {
    console.log('chunksHash', data.chunksHash)
  })
}

/**
 * Destroy Worker Thread
 */
function handleDestroyWorkerPool() {
  destroyWorkerPool()
}

[WARNING]

If you are using Vite as a build tool and are experiencing dependency optimization issues with the hash-worker package, you can exclude the hash-worker package from dependency optimization in the vite.config.js file.

Attention: Old version of vite may not emit errors.

// vite.config.js
import {defineConfig} from 'vite';
import vue from '@vitejs/plugin-vue'

export default defineConfig({
  plugins: [vue()],
  optimizeDeps: {
    exclude: ['hash-worker'] // new added
  }
})

HashChksParam

HashChksParam is used to configure the parameters needed to calculate the hash.

Config

// strategy.ts
export enum Strategy {
  md5 = 'md5',
  crc32 = 'crc32',
  mixed = 'mixed',
}

When Strategy.mixed strategy is used, if the number of file fragments is less than borderCount, the md5 algorithm will be used to calculate the hash value to build the MerkleTree. Otherwise, it switches to using the crc32 algorithm for MerkleTree construction.

HashChksRes

HashChksRes is the returned result after calculating the hash value.

FileMetaInfo

• These measurements were made with Chrome v126 on a Zen3 Desktop CPU

MIT

Contributions are welcome! If you find a bug or want to add a new feature, please open an issue or submit a pull request.