@types/merkle v0.6.4

Installation

npm install --save @types/merkle

Summary

This package contains type definitions for merkle (https://github.com/c-geek/merkle).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/merkle.

index.d.ts

// Type definitions for merkle 0.6
// Project: https://github.com/c-geek/merkle
// Definitions by: Yu Hsin Lu <https://github.com/kerol2r20>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3

/// <reference types="node" />

/* =================== USAGE ===================

    import merkle = require("merkle");

    const stream = merkle('sha256');
    const merkleTree = stream.sync([1, 2, 3, 4, 5, 6, 7, 8]);
    merkleTree.root();

 =============================================== */

import stream = require("stream");

declare function merkle(
    hashname: "sha512" | "sha256" | "sha1" | "md5" | "ripemd160" | "whirlpool" | "none",
    useUpperCaseForHash?: boolean): MerkleStream;

declare class MerkleStream extends stream.Transform {
    sync(leaves: any[]): MerkleTree;
    async(leaves: any[], callback: (err: string, tree: MerkleTree) => void): void;
    json(): MerkleStream;
}

declare class MerkleTree {
    root(): string;
    level(level: number): number | undefined;
    depth(): number;
    levels(): number;
    nodes(): number;
}

export = merkle;

Additional Details

• Last updated: Fri, 09 Jul 2021 02:32:35 GMT
• Dependencies: @types/node
• Global values: none

Credits

These definitions were written by Yu Hsin Lu.