helper-fns - npm Package Compare versions

Comparing version 2.5.1 to 2.5.2

dist/index.d.ts

@@ -318,3 +318,3 @@ declare const assert: (condition: boolean, message: string) => asserts condition;
  * @param {number} [a=1]
- * @param {number} [b=0]
+ * @param {number} [b=9]
  * @return {*}  {number}
@@ -328,3 +328,3 @@ */
  * @export
- * @param {number} [length=0]
+ * @param {number} [length=4]
  * @returns
@@ -334,9 +334,14 @@ */
 /**
- *
- * Helper to generate random token
- * @export
- * @returns
+ * It returns a random string of characters, concatenated with another random string of characters
+ * @returns A function that returns a string of random characters.
  */
 declare const randomToken: () => string;
 /**
+ * It replaces all instances of the identifier with a random number.
+ * @param {string} str - The string  format you want to replace the tokens in.
+ * @param [identifier=X] - The identifier that will be replaced with a random number.
+ * @returns A string with all instances of the identifier replaced with a random number.
+ */
+declare const orderedToken: (str: string, identifier?: string) => string;
+/**
  *
@@ -470,2 +475,2 @@ * Get string after a substring
 
-export { assert, autoParseValues, capitalize, capitalizeEveryWord, clearUndefined, clone, common, debounce, decrypt, difference, dropRight, encrypt, ensurePrefix, enumToString, fixedDecimal, flattenDeep, formatDuration, generateRandomString, groupBy, invertObj, isBoolean, isDate, isDef, isEmpty, isFunction, isNotEmpty, isNumber, isObject, isString, lowerFirst, noop, normalizeEmail, objectArrayToArray, omit, orderBy, pick, pipes, pluck, randomNumber, randomString, randomToken, readFile, removeEmpty, renameKeys, resolverArgs, shuffle, slash, slugify, strAfter, strBefore, stringifyQueryParams, sumOfAnArray, template, throttle, timeTaken, toString, unescapeHTML, union, unique };
+export { assert, autoParseValues, capitalize, capitalizeEveryWord, clearUndefined, clone, common, debounce, decrypt, difference, dropRight, encrypt, ensurePrefix, enumToString, fixedDecimal, flattenDeep, formatDuration, generateRandomString, groupBy, invertObj, isBoolean, isDate, isDef, isEmpty, isFunction, isNotEmpty, isNumber, isObject, isString, lowerFirst, noop, normalizeEmail, objectArrayToArray, omit, orderBy, orderedToken, pick, pipes, pluck, randomNumber, randomString, randomToken, readFile, removeEmpty, renameKeys, resolverArgs, shuffle, slash, slugify, strAfter, strBefore, stringifyQueryParams, sumOfAnArray, template, throttle, timeTaken, toString, unescapeHTML, union, unique };

package.json

 {
   "name": "helper-fns",
   "type": "module",
-  "version": "2.5.1",
+  "version": "2.5.2",
   "packageManager": "pnpm@7.2.1",
@@ -50,7 +50,7 @@ "description": "Some common utilities functions for everyday backend usage with zero dependencies",
   "devDependencies": {
-    "@antfu/eslint-config": "^0.25.1",
-    "@antfu/ni": "^0.16.2",
-    "@types/node": "^18.0.0",
+    "@antfu/eslint-config": "^0.25.2",
+    "@antfu/ni": "^0.16.3",
+    "@types/node": "^18.0.3",
     "bumpp": "^8.2.1",
-    "eslint": "^8.18.0",
+    "eslint": "^8.19.0",
     "esno": "^0.16.3",
@@ -60,5 +60,5 @@ "rimraf": "^3.0.2",
     "unbuild": "^0.7.4",
-    "vite": "^2.9.12",
-    "vitest": "^0.15.1"
+    "vite": "^2.9.14",
+    "vitest": "^0.18.0"
   }
 }

README.md

@@ -38,2 +38,11 @@ # helper-fns
 
+# orderedToken
+
+Generates token based on user defined format
+
+```js
+orderedToken("RU-XXXXX") // RU-16891
+```
+
+
 # pick
@@ -40,0 +49,0 @@

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

40515

increased by2.58%

Lines of code

1159

increased by1.58%

Number of lines in readme file

353

increased by2.62%

No dependency changes