@ztimson/utils 0.24.12 → 0.25.1

package/dist/jwt.d.ts

@@ -1,5 +1,13 @@
 /**
- * Decode a JWT payload, this will not check for tampering so be careful
+ * Creates a JSON Web Token (JWT) using the provided payload.
+ *
+ * @param {object} payload The payload to include in the JWT.
+ * @param signature Add a JWT signature
+ * @return {string} The generated JWT string.
+ */
+export declare function createJwt(payload: object, signature?: string): string;
+/**
+ * Decode a JSON Web Token (JWT) payload, this will not check for tampering so be careful
  *
  * @param {string} token JWT to decode
  * @return {unknown} JWT payload

package/dist/math.d.ts

@@ -7,9 +7,10 @@
  * ```
  *
  * @param {number} num Number to convert
+ * @param maxDen
  * @return {string} Fraction with remainder
  */
-export declare function dec2Frac(num: number): string;
+export declare function dec2Frac(num: number, maxDen?: number): string;
 /**
  * Convert fraction to decimal number
  *

package/dist/misc.d.ts

@@ -22,5 +22,13 @@ export declare function gravatar(email: string, def?: string): string;
  * @return {string} New escaped sequence
  */
 export declare function escapeRegex(value: string): string;
+/**
+ * Represents a function that listens for events and handles them accordingly.
+ *
+ * @param {PathEvent} event - The event object containing data related to the triggered event.
+ * @param {...any} args - Additional arguments that may be passed to the listener.
+ * @returns {any} The return value of the listener, which can vary based on implementation.
+ */
 export type Listener = (event: PathEvent, ...args: any[]) => any;
+/** Represents a function that can be called to unsubscribe from an event, stream, or observer */
 export type Unsubscribe = () => void;

package/dist/search.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Filters an array of objects based on a search term and optional regex checking.
+ *
+ * @param {Array} rows Array of objects to filter
+ * @param {string} search The logic string or regext to filter on
+ * @param {boolean} [regex=false] Treat search expression as regex
+ * @param {Function} [transform=(r) => r] - Transform rows before filtering
+ * @return {Array} The filtered array of objects that matched search
+ */
 export declare function search(rows: any[], search: string, regex?: boolean, transform?: Function): any[];
 /**
  * Test an object against a logic condition. By default values are checked

package/dist/types.d.ts

@@ -1,24 +1,4 @@
-/**
- * Return keys on a type as an array of strings
- *
- * @example
- * ```ts
- * type Person = {
- * 	  firstName: string;
- * 	  lastName: string;
- * 	  age: number;
- * }
- *
- * const keys = typeKeys<Person>();
- * console.log(keys); // Output: ["firstName", "lastName", "age"]
- * ```
- *
- * @return {Array<keyof T>} Available keys
- */
-export declare function typeKeys<T extends object>(): Array<keyof T>;
-/**
- * Mark all properties as writable
- */
+/** Mark all properties as writable */
 export type Writable<T> = {
     -readonly [P in keyof T]: T[P];
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ztimson/utils",
-	"version": "0.24.12",
+	"version": "0.25.1",
 	"description": "Utility library",
 	"author": "Zak Timson",
 	"license": "MIT",
@@ -31,6 +31,7 @@
 	},
 	"devDependencies": {
 		"@types/jest": "^29.5.12",
+		"fake-indexeddb": "^6.0.1",
 		"jest": "^29.7.0",
 		"jest-junit": "^16.0.0",
 		"ts-jest": "^29.1.2",