1.0.0 • Published 7 months ago

artia-dev-kit v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
7 months ago

MercadoPagoManager

GitHub License

Project

  • 🔐 DevKits is a lightweight and efficient library for create and compare hashed password.

Installation

You can install DevKits using npm or yarn.

npm install artia-dev-kit

or

yarn add artia-dev-kit

Usage

Example code in javaScript

const { DevKits } = require("artia-dev-kit");
// Generate a salt of 1000 characters by default.
const salt = DevKits.createSalt();

// Create a hash for a password using the generated salt.
const hashedPassword = DevKits.createHashPassword("myPassword", salt);

// Compare a plain text password with the hashed password.
const isPasswordMatch = DevKits.compareHashedPassword(
  "myPassword",
  hashedPassword
);

if (isPasswordMatch) {
  console.log("The password is correct.");
} else {
  console.log("The password is incorrect.");
}

Example code in typeScript

import { DevKits } from "artia-dev-kit";
// Generate a salt of 1000 characters by default.
const salt = DevKits.createSalt();

// Create a hash for a password using the generated salt.
const hashedPassword = DevKits.createHashPassword("myPassword", salt);

// Compare a plain text password with the hashed password.
const isPasswordMatch = DevKits.compareHashedPassword(
  "myPassword",
  hashedPassword
);

if (isPasswordMatch) {
  console.log("The password is correct.");
} else {
  console.log("The password is incorrect.");
}

📂 References

Here's the code references for DevKits.

🔑 createSalt

Create a random salt.

  • saltLength - The length of the generated salt
const salt = DevKits.createSalt(10000);

// return random salt

🔒 createHashPassword

Create a hash for a given password using a salt.

  • password - The password to be hashed.
  • salt - The salt to be used in the hash.
const hashedPassword = DevKits.createHashPassword(password, salt);
console.log(hashedPassword); // The hashed password as a string

🔐 compareHashedPassword

Create a hash for a given password using a salt.

  • password - The plain text password.
  • hashedPassword - The hashed password with salt.
const isPasswordMatch = DevKits.compareHashedPassword(password, hashedPassword); // True if the passwords match, false otherwise.

if (isPasswordMatch) {
  console.log("The password is correct.");
} else {
  console.log("The password is incorrect.");
}

🧱 Contributing

If you want to contribute to the development of this library, please feel free to open issues and pull requests on the GitHub repository.

📝 License

This project is licensed under the ISC License - refer to the LICENSE file for details.


Powered by Miuzaki 👋

Discord: Contact me! Github Miuzaki: github.com/Miuzaki  

1.0.0

7 months ago