@tixyel/streamelements 6.1.0 → 6.2.1

package/dist/index.d.ts

@@ -2038,6 +2038,7 @@ declare namespace Helper {
          * @param amount - Number to balance
          * @param min - Minimum value
          * @param max - Maximum value
+         * @param decimals - Number of decimal places to round to (default is 0)
          * @returns - Balanced number
          * @example
          * ```javascript
@@ -2045,7 +2046,7 @@ declare namespace Helper {
          * console.log(balancedValue); // 100
          * ```
          */
-        function balance(amount: number, min?: number, max?: number): number;
+        function balance(amount: number, min?: number, max?: number, decimals?: number): number;
         /**
          * Rounds a number to a specified number of decimal places
          * @param value - Number to round
@@ -2053,43 +2054,27 @@ declare namespace Helper {
          * @returns Rounded number
          * @example
          * ```javascript
-         * const roundedValue = Simulation.number.float(3.14159, 3);
+         * const roundedValue = Simulation.number.round(3.14159, 3);
          * console.log(roundedValue); // 3.142
          * ```
          */
         function round(value: number, decimals?: number): number;
-    }
-    namespace utils {
-        /**
-         * Delays execution for a specified number of milliseconds.
-         * @param ms - The number of milliseconds to delay.
-         * @returns A Promise that resolves after the specified delay.
-         */
-        function delay<R extends any, M extends number>(ms: M, callback?: () => R): Promise<R | null>;
-        /**
-         * Returns typed entries of an object.
-         * @param obj - The object to get entries from.
-         * @returns An array of key-value pairs from the object.
-         */
-        function typedEntries<K extends string, V>(obj: Record<K, V> | Array<V>): [K, V][];
-        /**
-         * Returns typed values of an object.
-         * @param obj - The object to get values from.
-         * @returns An array of values from the object.
-         */
-        function typedValues<K extends string, V>(obj: Record<K, V> | Array<V>): V[];
-        /**
-         * Returns typed keys of an object.
-         * @param obj - The object to get keys from.
-         * @returns An array of keys from the object.
-         */
-        function typedKeys<K extends string, V>(obj: Record<K, V> | Array<V>): K[];
         /**
-         * Selects an item based on weighted probabilities.
-         * @param items - An object where keys are items and values are their weights.
-         * @returns A randomly selected item based on the given probabilities.
+         * Generate random number
+         * @param min - Minimum value
+         * @param max - Maximum value
+         * @param float - Number of decimal places (0 for integer)
+         * @returns - Random number
+         * @example
+         * ```javascript
+         * const intNumber = number.random(1, 10);
+         * console.log(intNumber); // e.g. 7
+         *
+         * const floatNumber = number.random(1, 10, 2);
+         * console.log(floatNumber); // e.g. 3.14
+         * ```
          */
-        function probability<K extends string, V extends number>(items: Record<K, V>): K | undefined;
+        function number(min: number, max: number, float?: number): number;
     }
     namespace element {
         interface ScaleOptions<T extends HTMLElement> {
@@ -2219,6 +2204,24 @@ declare namespace Helper {
          * ```
          */
         function flatten(obj: Record<string, any>, stringify?: boolean, prefix?: string): Record<string, typeof stringify extends true ? string : string | number | boolean>;
+        /**
+         * Returns the entries of an object as an array of key-value pairs, with proper typing.
+         * @param obj - The object to retrieve entries from.
+         * @returns An array of key-value pairs from the object, typed as an array of tuples with key and value types.
+         */
+        function entries<K extends string, V>(obj: Record<K, V>): [K, V][];
+        /**
+         * Returns the values of an object as an array, with proper typing.
+         * @param obj - The object to retrieve values from.
+         * @returns An array of values from the object, typed as an array of the value type.
+         */
+        function values<K extends string, V>(obj: Record<K, V>): V[];
+        /**
+         * Returns the keys of an object as an array of strings, with proper typing.
+         * @param obj - The object to retrieve keys from.
+         * @returns An array of keys from the object, typed as an array of strings.
+         */
+        function keys<K extends string, V>(obj: Record<K, V>): K[];
     }
     namespace message {
         type BadgeOptions = Twitch.roles[] | Twitch.roles | `${Twitch.roles}, ${Twitch.roles}` | `${Twitch.roles}, ${Twitch.roles}, ${Twitch.roles}`;
@@ -2560,6 +2563,56 @@ declare namespace Helper {
          */
         function uuid(): string;
     }
+    namespace fn {
+        /**
+         * Apply function with given thisArg and arguments
+         * @param fn - Function to apply
+         * @param thisArg - Value to use as this when calling fn
+         * @param args - Arguments to pass to fn
+         * @returns Result of calling fn with thisArg and args
+         */
+        function apply<TThis, TArgs extends unknown[], TReturn>(fn: (this: TThis, ...args: TArgs) => TReturn, thisArg: TThis, args: TArgs): TReturn;
+        /**
+         * Call function with given thisArg and arguments
+         * @param fn - Function to call
+         * @param thisArg - Value to use as this when calling fn
+         * @param args - Arguments to pass to fn
+         * @returns Result of calling fn with thisArg and args
+         */
+        function call<TThis, TArgs extends unknown[], TReturn>(fn: (this: TThis, ...args: TArgs) => TReturn, thisArg: TThis, ...args: TArgs): TReturn;
+    }
+    namespace utils {
+        /**
+         * Delays execution for a specified number of milliseconds.
+         * @param ms - The number of milliseconds to delay.
+         * @returns A Promise that resolves after the specified delay.
+         */
+        function delay<R extends any, M extends number>(ms: M, callback?: () => R): Promise<R | null>;
+        /**
+         * Returns typed entries of an object.
+         * @param obj - The object to get entries from.
+         * @returns An array of key-value pairs from the object.
+         */
+        function typedEntries<K extends string, V>(obj: Record<K, V>): [K, V][];
+        /**
+         * Returns typed values of an object.
+         * @param obj - The object to get values from.
+         * @returns An array of values from the object.
+         */
+        function typedValues<K extends string, V>(obj: Record<K, V>): V[];
+        /**
+         * Returns typed keys of an object.
+         * @param obj - The object to get keys from.
+         * @returns An array of keys from the object.
+         */
+        function typedKeys<K extends string, V>(obj: Record<K, V>): K[];
+        /**
+         * Selects an item based on weighted probabilities.
+         * @param items - An object where keys are items and values are their weights.
+         * @returns A randomly selected item based on the given probabilities.
+         */
+        function probability<K extends string, V extends number>(items: Record<K, V>): K | undefined;
+    }
 }
 
 declare namespace Local {