@kikiutils/node/src/crypto-hash.ts

A modular utility library for Node.js offering secure hashing, flexible logging, datetime manipulation, and more.

/**
 * This file provides a set of functions for creating hash digests using different algorithms and bit lengths.
 * It includes functions for generating SHA-3 hash digests with bit lengths of 224, 256, 384, and 512,
 * as well as a function for generating MD5 hash digests.
 * These functions use the Node.js crypto module to generate the hashes.
 * Can only be used in Node.js/Deno/Bun runtimes.
 *
 * @example
 * ```typescript
 * import { cryptoSha3256 } from '@kikiutils/node/crypto-hash';
 *
 * console.log(cryptoSha3256('test')); // 36f028580bb02cc8272a9a020f4200e346e276ae664e45ee80745574e2f5ab80
 * ```
 */

import { createHash } from 'node:crypto';
import type {
    BinaryLike,
    BinaryToTextEncoding,
} from 'node:crypto';

export function cryptoMd5(data: BinaryLike, outputEncoding: BinaryToTextEncoding = 'hex') {
    return createHash('md5').update(data).digest(outputEncoding);
}

export function cryptoMd5ToBuffer(data: BinaryLike) {
    return createHash('md5').update(data).digest();
}

export function cryptoSha3224(data: BinaryLike, outputEncoding: BinaryToTextEncoding = 'hex') {
    return createHash('sha3-224').update(data).digest(outputEncoding);
}

export function cryptoSha3224ToBuffer(data: BinaryLike) {
    return createHash('sha3-224').update(data).digest();
}

export function cryptoSha3256(data: BinaryLike, outputEncoding: BinaryToTextEncoding = 'hex') {
    return createHash('sha3-256').update(data).digest(outputEncoding);
}

export function cryptoSha3256ToBuffer(data: BinaryLike) {
    return createHash('sha3-256').update(data).digest();
}

export function cryptoSha3384(data: BinaryLike, outputEncoding: BinaryToTextEncoding = 'hex') {
    return createHash('sha3-384').update(data).digest(outputEncoding);
}

export function cryptoSha3384ToBuffer(data: BinaryLike) {
    return createHash('sha3-384').update(data).digest();
}

export function cryptoSha3512(data: BinaryLike, outputEncoding: BinaryToTextEncoding = 'hex') {
    return createHash('sha3-512').update(data).digest(outputEncoding);
}

export function cryptoSha3512ToBuffer(data: BinaryLike) {
    return createHash('sha3-512').update(data).digest();
}