DefinitelyTyped/types/sha1/index.d.ts

31 lines
944 B
TypeScript

// Type definitions for sha1 1.1
// Project: https://github.com/pvorb/node-sha1
// Definitions by: Bill Sourour <https://github.com/arcdev1>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/// <reference types="node" />
/**
* js function for hashing messages with SHA1
*
* @param message - a string or buffer to hash
* @param options - an options object
* @returns the resultant SHA1 hash of the given message
*/
declare function main(message: string | Buffer, options?: Sha1AsStringOptions): string;
declare function main(message: string | Buffer, options?: Sha1AsBytesOptions): Uint8Array;
declare function main(message: string | Buffer, options?: Sha1Options): string | Uint8Array;
export = main;
interface Sha1AsStringOptions {
asBytes?: false;
asString?: boolean;
}
interface Sha1AsBytesOptions {
asBytes: true;
asString?: false;
}
type Sha1Options = Sha1AsStringOptions | Sha1AsBytesOptions;