esmile-useful - npm Package Compare versions

Comparing version 0.2.0-dev.0.0.4 to 0.2.0-dev.0.0.5

index.js

@@ -9,2 +9,3 @@ /* It's exporting all the functions in the file. */
 exports.generateKey = require("./src/gen/generateKey");
+exports.generatePassword = require("./src/gen/generatePassword");
 
@@ -11,0 +12,0 @@ exports.colorHashtag = require("./src/color/colorHashtag");

package.json

 {
   "name": "esmile-useful",
-  "version": "0.2.0-dev.0.0.4",
+  "version": "0.2.0-dev.0.0.5",
   "description": "Esmile Utility",
@@ -5,0 +5,0 @@ "main": "index.js",

readme.md

@@ -34,6 +34,7 @@ ## Installation
 
-| Function          | Description        |
-| ----------------- | ------------------ |
-| `generateCaptcha` | Generate a captcha |
-| `generateKey`     | Generate a key     |
+| Function           | Description                                                 |
+| ------------------ | ----------------------------------------------------------- |
+| `generateCaptcha`  | Generates a random captcha string with the specified length |
+| `generateKey`      | Generates a unique key with the specified prefix            |
+| `generatePassword` | Generates a random password of the specified length         |
 
@@ -40,0 +41,0 @@ ### Colors

src/gen/generateCaptcha.js

 /**
- * @description Generate a captcha
+ * @description Generates a random captcha string with the specified length.
  * @author Zastinian
- * @param {Number} captchaLength
+ * @param {number} [captchaLength=5] - The length of the captcha string to generate (defaults to 5).
  * @example
  * console.log(generateCaptcha(number))
- * @returns {String} String
+ * @returns {String} The generated captcha string.
  */
@@ -9,0 +9,0 @@ function generateCaptcha(captchaLength) {

src/gen/generateKey.js

 /**
- * @description Generate a key
+ * @description Generates a unique key with the specified prefix.
  * @author Zastinian
- * @param {String} prefix
+ * @param {string} [prefix] - The prefix to use for the key (defaults to "PREFIX").
  * @example
  * console.log(generateKey('PREFIX'))
- * @returns {String} String
+ * @returns {string} The generated key.
  */
@@ -9,0 +9,0 @@ function generateKey(prefix) {

src/utils/formats.js

 /**
- * Formats a number to a string with thousand separators.
+ * @description Formats a number to a string with thousand separators.
+ * @author Zastinian
  * @param {number} number - The number to format.
@@ -13,3 +14,4 @@ * @example
 /**
- * Formats a string to title case.
+ * @description Formats a string to title case.
+ * @author Zastinian
  * @param {string} str - The string to format.
@@ -30,3 +32,4 @@ * console.log(formats.TitleCase("Example of text"))
 /**
- * Formats a string to sentence case.
+ * @description Formats a string to sentence case.
+ * @author Zastinian
  * @param {string} str - The string to format.
@@ -43,3 +46,4 @@ * console.log(formats.SentenceCase("Example Of Text"))
 /**
- * Formats a string to camel case.
+ * @description Formats a string to camel case.
+ * @author Zastinian
  * @param {string} str - The string to format.
@@ -58,3 +62,4 @@ * console.log(formats.CamelCase("Example of text"))
 /**
- * Formats a string to kebab case.
+ * @description Formats a string to kebab case.
+ * @author Zastinian
  * @param {string} str - The string to format.
@@ -69,3 +74,4 @@ * console.log(formats.KebabCase("Example of text"))
 /**
- * Formats a string to snake case.
+ * @description Formats a string to snake case.
+ * @author Zastinian
  * @param {string} str - The string to format.
@@ -80,3 +86,4 @@ * console.log(formats.SnakeCase("Example of text"))
 /**
- * Formats a date as a string with a customizable order of day, month and year.
+ * @description Formats a date as a string with a customizable order of day, month and year.
+ * @author Zastinian
  * @param {Date} date - The date to format.
@@ -123,3 +130,2 @@ * @param {string} [order="dmy"] - The order in which to display the day, month and year.
 
-/* Exporting the functions to be used in other files. */
 module.exports = {
@@ -126,0 +132,0 @@ Number,

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

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

96985

increased by1.48%

Number of package files

21

increased by5%

Lines of code

3363

increased by0.75%

Number of lines in readme file

67

increased by1.52%

No dependency changes