@types/bcrypt - npm Package Compare versions

Comparing version 3.0.1 to 5.0.0

bcrypt/index.d.ts

@@ -1,2 +0,2 @@
-// Type definitions for bcrypt 3.0
+// Type definitions for bcrypt 5.0
 // Project: https://www.npmjs.org/package/bcrypt
@@ -6,65 +6,194 @@ // Definitions by:  Peter Harris <https://github.com/codeanimal>
 //                  David Stapleton <https://github.com/dstapleton92>
+//                  BendingBender <https://github.com/BendingBender>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
+/// <reference types="node" />
 
 /**
- * @param rounds    The cost of processing the data. Default 10.
- * @param minor     The minor version of bcrypt to use. Either 'a' or 'b'. Default 'b'.
+ * @param rounds The cost of processing the data. Default 10.
+ * @param minor The minor version of bcrypt to use. Either 'a' or 'b'. Default 'b'.
+ *
+ * @example
+ * import * as bcrypt from 'bcrypt';
+ * const saltRounds = 10;
+ *
+ * const salt = bcrypt.genSaltSync(saltRounds);
  */
-export declare function genSaltSync(rounds?: number, minor?: string): string;
+export declare function genSaltSync(rounds?: number, minor?: "a" | "b"): string;
 
 /**
- * @param rounds    The cost of processing the data. Default 10.
- * @param callback  A callback to be fire once the salt has been generated. Uses eio making it asynchronous.
+ * @param rounds The cost of processing the data. Default 10.
+ * @param minor The minor version of bcrypt to use. Either 'a' or 'b'. Default 'b'.
  * @return A promise to be either resolved with the generated salt or rejected with an Error
+ *
+ * @example
+ * import * as bcrypt from 'bcrypt';
+ * const saltRounds = 10;
+ *
+ * (async () => {
+ *     const salt = await bcrypt.genSalt(saltRounds);
+ * })();
  */
-export declare function genSalt(rounds?: number, callback?: (err: Error, salt: string) => void): Promise<string>;
+export declare function genSalt(rounds?: number, minor?: "a" | "b"): Promise<string>;
 
 /**
- * @param rounds    The cost of processing the data. Default 10.
- * @param minor     The minor version of bcrypt to use. Either 'a' or 'b'. Default 'b'.
- * @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
+ * @param rounds The cost of processing the data. Default 10.
+ * @param minor The minor version of bcrypt to use. Either 'a' or 'b'. Default 'b'.
+ * @param callback A callback to be fire once the salt has been generated. Uses eio making it asynchronous.
+ *
+ * @example
+ * import * as bcrypt from 'bcrypt';
+ * const saltRounds = 10;
+ *
+ * // Technique 1 (generate a salt and hash on separate function calls):
+ * bcrypt.genSalt(saltRounds, (err, salt) => {
+ *     // ...
+ * });
  */
-export declare function genSalt(rounds?: number, minor?: string, callback?: (err: Error, salt: string) => void): Promise<string>;
+export declare function genSalt(callback: (err: Error | undefined, salt: string) => any): void;
+export declare function genSalt(rounds: number, callback: (err: Error | undefined, salt: string) => any): void;
+export declare function genSalt(
+    rounds: number,
+    minor: "a" | "b",
+    callback: (err: Error | undefined, salt: string) => any,
+): void;
 
 /**
- * @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
+ * @param data The data to be encrypted.
+ * @param saltOrRounds The salt to be used to hash the password. If specified as a number then a
+ * salt will be generated with the specified number of rounds and used.
+ *
+ * @example
+ * import * as bcrypt from 'bcrypt';
+ * const saltRounds = 10;
+ * const myPlaintextPassword = 's0/\/\P4$$w0rD';
+ *
+ * // Technique 1 (generate a salt and hash on separate function calls):
+ * const salt = bcrypt.genSaltSync(saltRounds);
+ * const hash = bcrypt.hashSync(myPlaintextPassword, salt);
+ * // Store hash in your password DB.
+ *
+ * // Technique 2 (auto-gen a salt and hash):
+ * const hash2 = bcrypt.hashSync(myPlaintextPassword, saltRounds);
+ * // Store hash in your password DB.
  */
-export declare function genSalt(callback?: (err: Error, salt: string) => void): Promise<string>;
+export declare function hashSync(data: string | Buffer, saltOrRounds: string | number): string;
 
 /**
- * @param data  The data to be encrypted.
- * @param salt  The salt to be used in encryption.
+ * @param data The data to be encrypted.
+ * @param saltOrRounds The salt to be used in encryption. If specified as a number then a
+ * salt will be generated with the specified number of rounds and used.
+ * @return A promise to be either resolved with the encrypted data salt or rejected with an Error
+ *
+ * @example
+ * import * as bcrypt from 'bcrypt';
+ * const saltRounds = 10;
+ * const myPlaintextPassword = 's0/\/\P4$$w0rD';
+ *
+ * (async () => {
+ *     // Technique 1 (generate a salt and hash on separate function calls):
+ *     const salt = await bcrypt.genSalt(saltRounds);
+ *     const hash = await bcrypt.hash(myPlaintextPassword, salt);
+ *     // Store hash in your password DB.
+ *
+ *     // Technique 2 (auto-gen a salt and hash):
+ *     const hash2 = await bcrypt.hash(myPlaintextPassword, saltRounds);
+ *     // Store hash in your password DB.
+ * })();
  */
-export declare function hashSync(data: any, saltOrRounds: string | number): string;
+export declare function hash(data: string | Buffer, saltOrRounds: string | number): Promise<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
+ * @param data The data to be encrypted.
+ * @param saltOrRounds The salt to be used in encryption. If specified as a number then a
+ * salt will be generated with the specified number of rounds and used.
+ * @param callback A callback to be fired once the data has been encrypted. Uses eio making it asynchronous.
+ *
+ * @example
+ * import * as bcrypt from 'bcrypt';
+ * const saltRounds = 10;
+ * const myPlaintextPassword = 's0/\/\P4$$w0rD';
+ *
+ * // Technique 1 (generate a salt and hash on separate function calls):
+ * bcrypt.genSalt(saltRounds, (err, salt) => {
+ *     bcrypt.hash(myPlaintextPassword, salt, (err, hash) => {
+ *         // Store hash in your password DB.
+ *     });
+ * });
+ *
+ * // Technique 2 (auto-gen a salt and hash):
+ * bcrypt.hash(myPlaintextPassword, saltRounds, (err, hash) => {
+ *     // Store hash in your password DB.
+ * });
  */
-export declare function hash(data: any, saltOrRounds: string | number, callback?: (err: Error, encrypted: string) => void): Promise<string>;
+export declare function hash(
+    data: string | Buffer,
+    saltOrRounds: string | number,
+    callback: (err: Error | undefined, encrypted: string) => any,
+): void;
 
 /**
- * @param data      The data to be encrypted.
+ * @param data The data to be encrypted.
  * @param encrypted The data to be compared against.
+ *
+ * @example
+ * import * as bcrypt from 'bcrypt';
+ * const myPlaintextPassword = 's0/\/\P4$$w0rD';
+ * const someOtherPlaintextPassword = 'not_bacon';
+ *
+ * // Load hash from your password DB.
+ * bcrypt.compareSync(myPlaintextPassword, hash); // true
+ * bcrypt.compareSync(someOtherPlaintextPassword, hash); // false
  */
-export declare function compareSync(data: any, encrypted: string): boolean;
+export declare function compareSync(data: string | Buffer, encrypted: string): boolean;
 
 /**
- * @param data      The data to be encrypted.
+ * @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
+ * @return A promise to be either resolved with the comparison result salt or rejected with an Error
+ *
+ * @example
+ * import * as bcrypt from 'bcrypt';
+ * const myPlaintextPassword = 's0/\/\P4$$w0rD';
+ * const someOtherPlaintextPassword = 'not_bacon';
+ *
+ * (async () => {
+ *     // Load hash from your password DB.
+ *     const result1 = await bcrypt.compare(myPlaintextPassword, hash);
+ *     // result1 == true
+ *
+ *     const result2 = await bcrypt.compare(someOtherPlaintextPassword, hash);
+ *     // result2 == false
+ * })();
  */
-export declare function compare(data: any, encrypted: string, callback?: (err: Error, same: boolean) => void): Promise<boolean>;
+export declare function compare(data: string | Buffer, encrypted: string): Promise<boolean>;
 
 /**
- * Return the number of rounds used to encrypt a given hash
+ * @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.
  *
+ * @example
+ * import * as bcrypt from 'bcrypt';
+ * const myPlaintextPassword = 's0/\/\P4$$w0rD';
+ * const someOtherPlaintextPassword = 'not_bacon';
+ *
+ * // Load hash from your password DB.
+ * bcrypt.compare(myPlaintextPassword, hash, (err, result) => {
+ *     // result == true
+ * });
+ * bcrypt.compare(someOtherPlaintextPassword, hash, (err, result) => {
+ *     // result == false
+ * });
+ */
+export declare function compare(
+    data: string | Buffer,
+    encrypted: string,
+    callback: (err: Error | undefined, same: boolean) => any,
+): void;
+
+/**
  * @param encrypted Hash from which the number of rounds used should be extracted.
+ * @returns The number of rounds used to encrypt a given hash.
  */
 export declare function getRounds(encrypted: string): number;

bcrypt/package.json

 {
     "name": "@types/bcrypt",
-    "version": "3.0.1",
+    "version": "5.0.0",
     "description": "TypeScript definitions for bcrypt",
@@ -21,2 +21,7 @@ "license": "MIT",
             "githubUsername": "dstapleton92"
+        },
+        {
+            "name": "BendingBender",
+            "url": "https://github.com/BendingBender",
+            "githubUsername": "BendingBender"
         }
@@ -32,5 +37,7 @@ ],
     "scripts": {},
-    "dependencies": {},
-    "typesPublisherContentHash": "cf13d742ff16fe811b300f044d763d7b1dd8aa183fdd9e3b341f647f6396f486",
+    "dependencies": {
+        "@types/node": "*"
+    },
+    "typesPublisherContentHash": "1d33fefdbd82ebb51d783a3e79d6c8f564272b94653fac0c1f9f795b5ddce505",
     "typeScriptVersion": "3.5"
 }

bcrypt/README.md

@@ -11,7 +11,7 @@ # Installation
 ### Additional Details
- * Last updated: Fri, 09 Apr 2021 22:01:17 GMT
- * Dependencies: none
+ * Last updated: Sun, 09 May 2021 03:31:24 GMT
+ * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
  * Global values: none
 
 # Credits
-These definitions were written by [ Peter Harris](https://github.com/codeanimal), [Ayman Nedjmeddine](https://github.com/IOAyman), and [David Stapleton](https://github.com/dstapleton92).
+These definitions were written by [ Peter Harris](https://github.com/codeanimal), [Ayman Nedjmeddine](https://github.com/IOAyman), [David Stapleton](https://github.com/dstapleton92), and [BendingBender](https://github.com/BendingBender).

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

10216

increased by69.76%

Lines of code

187

increased by216.95%

Worsened metrics

Dependency count

1

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@types/node@*

• + Added@types/node@22.5.5(transitive)

• + Addedundici-types@6.19.8(transitive)