Installation
npm install --save @types/checksum
Summary
This package contains type definitions for checksum (https://github.com/dshaw/checksum).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/checksum.
index.d.ts
declare namespace checksum {
/**
* Options object for all functions
*/
interface ChecksumOptions {
/**
* Algorithm to use, default 'sha1'
* Can be 'sha1' or 'md5' (see module 'crypto').
*/
algorithm?: string;
/**
* Encoding to use, default 'hex'
* Can be 'base64' (see NodeJS encoding support)
*/
encoding?: string;
}
/**
* Generate the checksum for a file on disk
* @param filename The file name
* @param callback Callback which is called with the result or an error
*/
function file(filename: string, callback: (error: Error, hash: string) => void): void;
/**
* Generate the checksum for a file on disk
* @param filename The file name
* @param options Options object to indicate hash algo
* @param callback Callback which is called with the result or an error
*/
function file(filename: string, options: ChecksumOptions, callback: (error: Error, hash: string) => void): void;
}
/**
* Generates a checksum for the given value
* @param value Any value
* @param options Allows to set the algorithm
* @returns Checksum
*/
declare function checksum(value: any, options?: checksum.ChecksumOptions): string;
export = checksum;
Additional Details
- Last updated: Mon, 06 Nov 2023 22:41:05 GMT
- Dependencies: none
Credits
These definitions were written by Rogier Schouten.