mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
58 lines
2.5 KiB
TypeScript
58 lines
2.5 KiB
TypeScript
// Type definitions for bcrypt 1.0
|
|
// Project: https://www.npmjs.org/package/bcrypt
|
|
// Definitions by: Peter Harris <https://github.com/codeanimal>, Ayman Nedjmeddine <https://github.com/IOAyman>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
|
|
/**
|
|
* @param rounds The cost of processing the data. Default 10.
|
|
*/
|
|
export declare function genSaltSync(rounds?: number): string;
|
|
|
|
/**
|
|
* @param rounds The cost of processing the data. Default 10.
|
|
* @param callback A callback to be fire once the sald has been generated. Uses eio making it asynchronous.
|
|
* @return A promise to be either resolved with the generated salt or rejected with an Error
|
|
*/
|
|
export declare function genSalt(rounds: number, callback?: (err: Error, salt: string) => void): Promise<string>;
|
|
/**
|
|
* @param callback A callback to be fire once the sald has been generated. Uses eio making it asynchronous.
|
|
* @return A promise to be either resolved with the generated salt or rejected with an Error
|
|
*/
|
|
export declare function genSalt(callback?: (err: Error, salt: string) => void): Promise<string>;
|
|
|
|
/**
|
|
* @param data The data to be encrypted.
|
|
* @param salt The salt to be used in encryption.
|
|
*/
|
|
export declare function hashSync(data: any, saltOrRounds: string | number): string;
|
|
|
|
/**
|
|
* @param data The data to be encrypted.
|
|
* @param salt The salt to be used in encryption.
|
|
* @param callback A callback to be fired once the data has been encrypted. Uses eio making it asynchronous.
|
|
* @return A promise to be either resolved with the encrypted data salt or rejected with an Error
|
|
*/
|
|
export declare function hash(data: any, saltOrRounds: string | number, callback?: (err: Error, encrypted: string) => void): Promise<string>;
|
|
|
|
/**
|
|
* @param data The data to be encrypted.
|
|
* @param encrypted The data to be compared against.
|
|
*/
|
|
export declare function compareSync(data: any, encrypted: string): boolean;
|
|
|
|
/**
|
|
* @param data The data to be encrypted.
|
|
* @param encrypted The data to be compared against.
|
|
* @param callback A callback to be fire once the data has been compared. Uses eio making it asynchronous.
|
|
* @return A promise to be either resolved with the comparision result salt or rejected with an Error
|
|
*/
|
|
export declare function compare(data: any, encrypted: string, callback?: (err: Error, same: boolean) => void): Promise<boolean>;
|
|
|
|
/**
|
|
* Return the number of rounds used to encrypt a given hash
|
|
*
|
|
* @param encrypted Hash from which the number of rounds used should be extracted.
|
|
*/
|
|
export declare function getRounds(encrypted: string): number;
|