@types/keccak/README.md

TypeScript definitions for keccak

# Installation
> `npm install --save @types/keccak`

# Summary
This package contains type definitions for keccak (https://github.com/cryptocoinjs/keccak#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/keccak.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/keccak/index.d.ts)
````ts
/// <reference types="node" />

import { Transform, TransformOptions } from "stream";

declare namespace createHash {
    class Keccak extends Transform {
        constructor(
            rate: number,
            capacity: number,
            delimitedSuffix: number | null,
            hashBitLength: number,
            options: TransformOptions,
        );
        update(data: string | Buffer, encoding?: BufferEncoding): Keccak;
        digest(): Buffer;
        digest(encoding: BufferEncoding): string;
    }

    class Shake extends Transform {
        constructor(rate: number, capacity: number, delimitedSuffix: number | null, options: TransformOptions);
        update(data: string | Buffer, encoding?: BufferEncoding): Shake;
        squeeze(dataByteLength: number): Buffer;
        squeeze(dataByteLength: number, encoding: BufferEncoding): string;
    }

    type KeccakAlgorithm = "keccak224" | "keccak256" | "keccak384" | "keccak512";
    type Sha3Algorithm = "sha3-224" | "sha3-256" | "sha3-384" | "sha3-512";
    type ShakeAlgorithm = "shake128" | "shake256";
}

declare function createHash(
    algorithm: createHash.KeccakAlgorithm | createHash.Sha3Algorithm,
    options?: TransformOptions,
): createHash.Keccak;

declare function createHash(
    algorithm: createHash.ShakeAlgorithm,
    options?: TransformOptions,
): createHash.Shake;

export = createHash;

````

### Additional Details
 * Last updated: Mon, 07 Oct 2024 22:07:58 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)

# Credits
These definitions were written by [odan](https://github.com/odanado).