@kizmann/pico-js 2.0.9 → 2.0.11

package/types/dom/DomRectangle.d.ts

@@ -16,6 +16,14 @@ export declare class PicoDomRectangle {
      * @returns {number} Number value
      */
     static num(value: any): number;
+    /**
+     * Get bounding rectangle
+     *
+     * @example Dom.find("div").rect()
+     *
+     * @param {any} [fallback] Fallback value
+     * @returns {any} Rect object
+     */
     rect(fallback?: any): any;
     /**
      * Get margin values

package/types/tool/scope.d.ts

@@ -22,6 +22,12 @@ export declare function browser(): void;
  * @returns {void} No return value
  */
 export declare function device(): void;
+/**
+ * Trait multiple classes
+ *
+ * @param {any[]} values Class array
+ * @returns {any} Traited class
+ */
 export declare function trait(values: any[]): any;
 declare const _default: {
     go: typeof go;

package/types/utils/Array.d.ts

@@ -1,4 +1,3 @@
-import { Arr } from "../index.esm.ts";
 export declare class PicoArray {
     /**
      * Wrap value into an array
@@ -43,7 +42,25 @@ export declare class PicoArray {
      * @returns {any} Splice result
      */
     static unset(target: any, index: number): any;
+    /**
+     * Get previous index
+     *
+     * @example Arr.prev([1,2,3], 0) // => 2
+     *
+     * @param {any} target Target array
+     * @param {number} index Current index
+     * @returns {number} Previous index
+     */
     static prev(target: any, index: number): number;
+    /**
+     * Get next index
+     *
+     * @example Arr.next([1,2,3], 2) // => 0
+     *
+     * @param {any} target Target array
+     * @param {number} index Current index
+     * @returns {number} Next index
+     */
     static next(target: any, index: number): number;
     /**
      * Create array with callback values
@@ -170,7 +187,41 @@ export declare class PicoArray {
      * @returns {any} Mapped tree
      */
     static recursive(value: any, key: string, cb: Function, cascade?: any[]): any;
-    static cascade(value: any, childs: string, key: string, cascade?: any[], result?: any): any;
+    /**
+     * Run callback on cascade
+     *
+     * @example Arr.cascade({a:1, b:[{a:2}]}, "b", v => v.a) // => [1, 2]
+     *
+     * @param {any} value Input object
+     * @param {string} childs Child key
+     * @param {Function} cb Callback fn
+     * @param {any[]} [cascade] Initial cascade
+     * @param {any[]} [result] Initial result
+     * @returns {any} Cascade result
+     */
+    static cascade(value: any, childs: string, cb: Function, cascade?: any[], result?: any[]): any;
+    /**
+     * Find item in cascade
+     *
+     * @example Arr.cascadeFind({a:1, b:[{a:2}]}, "b", v => v.a === 2) // => [{...}, {a:2}]
+     *
+     * @param {any} value Input object
+     * @param {string} childs Child key
+     * @param {Function} cb Callback fn
+     * @returns {any} Find result
+     */
+    static cascadeFind(value: any, childs: string, cb: Function): any;
+    /**
+     * Map items in cascade
+     *
+     * @example Arr.cascadeMap({a:1, b:[{a:2}]}, "b", "a") // => {1: [1], 2: [1, 2]}
+     *
+     * @param {any} value Input object
+     * @param {string} childs Child key
+     * @param {string} key Map key
+     * @returns {any} Map result
+     */
+    static cascadeMap(value: any, childs: string, key: string): any;
     /**
      * Get matching indexes by filter
      *
@@ -403,7 +454,7 @@ export declare class PicoArray {
     /**
      * @see PicoArray.diff
      */
-    static diffrence: typeof Arr.diff;
+    static diffrence: typeof PicoArray.diff;
     /**
      * Get intersecting items
      *
@@ -416,7 +467,7 @@ export declare class PicoArray {
     /**
      * @see PicoArray.diff
      */
-    static intersect: typeof Arr.isect;
+    static intersect: typeof PicoArray.isect;
     /**
      * Extract property values from list
      *

package/types/utils/Locale.d.ts

@@ -8,7 +8,7 @@ export declare class PicoLocale {
     /**
      * Cached collator instance
      *
-     * @type {Intl.Collator|null}
+     * @type {Intl.Collator}
      */
     static $sort: Intl.Collator;
     /**

package/types/utils/Mixed.d.ts

@@ -295,6 +295,16 @@ export declare class PicoMixed {
      * @returns {Record<string, any>} Props map
      */
     static props(value: any, exclude?: string[]): Record<string, any>;
+    /**
+     * Extend object with another object
+     *
+     * @example Mix.extend({}, {a:1}) // => {a:1}
+     *
+     * @param {any} target Target object
+     * @param {any} value Source object
+     * @param {string[]} [exclude] Exclude keys
+     * @returns {any} Extended target
+     */
     static extend(target: any, value: any, exclude?: string[]): any;
     /**
      * Get static class props

package/types/utils/Object.d.ts

@@ -229,6 +229,15 @@ export declare class PicoObject {
      * @returns {boolean} True if matches
      */
     static matches(value: any, search: any): boolean;
+    /**
+     * Sort object entries by key
+     *
+     * @example Obj.sort({b:1,a:2}, "key") // => [{_key:"a",...},{_key:"b",...}]
+     *
+     * @param {any} value Input object
+     * @param {string} key Sort key
+     * @returns {any} Sorted result
+     */
     static sort(value: any, key: string): any;
 }
 export default PicoObject;