Kun-hash NPM | npm.io

Introduce

Kun-hash is a library for quickly calculating file hashes. It leverages WebWorkers for parallel computation based on hash-wasm, accelerating the speed of calculation when processing file chunks. Kun-hash supports two algorithms for hash calculation: md5 and crc32.

!WARNING The merkleHash calculated using Kun-hash is derived from computing the MerkleTree based on the hashes of file chunks, resulting in the rootHash, rather than the hash of the file itself.

Install

$ yarn add kun-hash

# or

$ npm install kun-hash

Usage

import { getFileHashChunks, Strategy, FileHashChunksResult, FileHashChunksParam } from 'kun-hash'

function handleGetHash() {
  const param: FileHashChunksParam = {
    file: file!,
    strategy: Strategy.crc32
  }

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

Options

FileHashChunksParam

params	type	default	description
file	File	/	The file for which the Hash is to be calculated (required)
chunkSize	number	10 (MB)	Chunk size
maxWorkerCount	number	8	The maximum number of webWorkers that can run simultaneously when calculating the Hash
strategy	Strategy	Strategy.mixed	Hash calculation strategy
borderCount	number	100	The boundary point of hash calculation rules in 'mixed' mode

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

When using the Strategy.mixed strategy, if the number of file fragments is less than the borderCount, the md5 value will be used to construct the MerkleTree; otherwise, crc32 will be used.