@kizmann/pico-js 2.0.9 → 2.0.11

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kizmann/pico-js",
-    "version": "2.0.9",
+    "version": "2.0.11",
     "license": "MIT",
     "type": "module",
     "private": false,

package/src/dom/DomAttribute.ts

@@ -360,14 +360,20 @@ export class PicoDomAttribute
 
 }
 
+/**
+ * @deprecated use Dom.style instead
+ */
 // @ts-ignore
-PicoDomAttribute.prototype.css = function (...args : Parameters<typeof PicoDomAttribute.style>) {
+PicoDomAttribute.prototype.css = function(...args : Parameters<typeof PicoDomAttribute.prototype.style>) : any {
     console.warn('Dom.css() is deprecated, use Dom.style() instead.');
     return this.style(...args);
 };
 
+/**
+ * @deprecated use Dom.remClass instead
+ */
 // @ts-ignore
-PicoDomAttribute.prototype.removeClass = function (...args : Parameters<typeof PicoDomAttribute.remClass>) {
+PicoDomAttribute.prototype.removeClass = function(...args : Parameters<typeof PicoDomAttribute.prototype.remClass>) : any {
     console.warn('Dom.removeClass() is deprecated, use Dom.remClass() instead.');
     return this.remClass(...args);
 };

package/src/dom/DomEvent.ts

@@ -1,4 +1,4 @@
-import { Arr, Hash, Mix, Obj, Dom, Run } from "../index.esm.ts";
+import { Arr, Hash, Mix, Dom, Run } from "../index.esm.ts";
 import { PicoDom, PicoDomInterface } from "../utils/Dom.ts";
 import PicoDomFinder from "./DomFinder.js";
 import PicoDomRectangle from "./DomRectangle.js";
@@ -43,12 +43,7 @@ export class PicoDomEvent
             el, event, cb, selector, pause, options
         });
 
-        console.log(this.els, el);
-        try {
-            el.addEventListener(event, cb, options);
-        } catch (e) {
-            console.log('ERRROR', this.els, el, e);
-        }
+        el.addEventListener(event, cb, options);
 
         return <PicoDom> <unknown> this;
     }
@@ -135,7 +130,7 @@ export class PicoDomEvent
      * @example Dom.find("div").off("click")
      *
      * @param {any} event Event name
-     * @param {string} [selector] Event selector
+     * @param {any} [selector] Event selector
      * @param {any} [options] Listener options
      * @returns {PicoDom} Current instance
      */
@@ -284,24 +279,36 @@ export class PicoDomEvent
 
 }
 
+/**
+ * @deprecated use Dom.once instead
+ */
 // @ts-ignore
-PicoDomEvent.prototype.one = function (...args : Parameters<typeof PicoDomEvent.prototype.once>) {
+PicoDomEvent.prototype.one = function(...args : Parameters<typeof PicoDomEvent.prototype.once>) : any {
     console.warn('Dom.one() is deprecated, use Dom.once() instead.');
     return this.once(...args);
 };
 
+/**
+ * @deprecated not implemented anymore
+ */
 // @ts-ignore
-PicoDomEvent.prototype.delayed = function () {
+PicoDomEvent.prototype.delayed = function() : void {
     console.error('Dom.delayed() is not implemented anymore.');
 };
 
+/**
+ * @deprecated not implemented anymore
+ */
 // @ts-ignore
-PicoDomEvent.prototype.pause = function () {
+PicoDomEvent.prototype.pause = function() : void {
     console.error('Dom.pause() is not implemented anymore.');
 };
 
+/**
+ * @deprecated not implemented anymore
+ */
 // @ts-ignore
-PicoDomEvent.prototype.unpause = function () {
+PicoDomEvent.prototype.unpause = function() : void {
     console.error('Dom.unpause() is not implemented anymore.');
 };
 

package/src/dom/DomFinder.ts

@@ -1,4 +1,4 @@
-import { Arr, Mix, Obj, Dom } from "../index.esm.ts";
+import { Arr, Mix, Dom } from "../index.esm.ts";
 import { PicoDomInterface, PicoDom } from "../utils/Dom.ts";
 
 export interface PicoDomFinder extends PicoDomInterface
@@ -610,32 +610,47 @@ export class PicoDomFinder
 
 }
 
+/**
+ * @deprecated use Dom.above instead
+ */
 // @ts-ignore
-PicoDomFinder.prototype.isParent = function (...args : Parameters<typeof PicoDomFinder.prototype.above>) {
+PicoDomFinder.prototype.isParent = function(...args : Parameters<typeof PicoDomFinder.prototype.above>) : any {
     console.warn('Dom.isParent() is deprecated, use Dom.above() instead.');
     return this.above(...args);
 };
 
+/**
+ * @deprecated use Dom.prev instead
+ */
 // @ts-ignore
-PicoDomFinder.prototype.previous = function () {
+PicoDomFinder.prototype.previous = function() : any {
     console.warn('Dom.previous() is deprecated, use Dom.prev() instead.');
     return this.prev();
 };
 
+/**
+ * @deprecated use Dom.filter instead
+ */
 // @ts-ignore
-PicoDomFinder.prototype.where = function (...args : Parameters<typeof PicoDomFinder.prototype.filter>) {
+PicoDomFinder.prototype.where = function(...args : Parameters<typeof PicoDomFinder.prototype.filter>) : any {
     console.warn('Dom.where() is deprecated, use Dom.filter() instead.');
     return this.filter(...args);
 };
 
+/**
+ * @deprecated use Dom.except instead
+ */
 // @ts-ignore
-PicoDomFinder.prototype.not = function (...args : Parameters<typeof PicoDomFinder.prototype.except>) {
+PicoDomFinder.prototype.not = function(...args : Parameters<typeof PicoDomFinder.prototype.except>) : any {
     console.warn('Dom.not() is deprecated, use Dom.except() instead.');
     return this.except(...args);
 };
 
+/**
+ * @deprecated not implemented anymore
+ */
 // @ts-ignore
-PicoDomFinder.prototype.getNot = () => {
+PicoDomFinder.prototype.getNot = function() : void {
     console.error('Dom.getNot() is not implemented anymore.');
 };
 

package/src/dom/DomGlobal.ts

@@ -168,11 +168,15 @@ export class PicoDomGlobal
 
         return <PicoDom> <unknown> this;
     }
-}
+    /**
+     * @deprecated not implemented anymore
+     */
+    // @ts-ignore
+    static required() : void
+    {
+        console.error('Dom.required() is not implemented anymore.');
+    }
 
-// @ts-ignore
-PicoDomGlobal.required = () => {
-    console.error('Dom.required() is not implemented anymore.');
 }
 
 export default PicoDomGlobal;

package/src/dom/DomMeta.ts

@@ -37,6 +37,7 @@ export class PicoDomMeta
 
         return <PicoDom> <unknown> this;
     }
+
 }
 
 // @ts-ignore

package/src/dom/DomObserver.ts

@@ -1,4 +1,3 @@
-import { Arr, Mix, Obj, Dom } from "../index.esm.ts";
 import { PicoDom, PicoDomInterface } from "../utils/Dom.ts";
 
 export interface PicoDomObserver extends PicoDomInterface

package/src/dom/DomPopover.ts

@@ -14,6 +14,16 @@ export interface PicoDomPopover extends PicoDomInterface,
 export class PicoDomPopover
 {
 
+    /**
+     * Calculate popover position
+     *
+     * @example Dom.find(".popover").popover(".target", "bottom-center")
+     *
+     * @param {any} target Target element
+     * @param {string} [position] Popover position
+     * @param {any} [options] Popover options
+     * @returns {any} Position result
+     */
     popover(target : any, position : string = 'botttom-center', options : any = {}) : any
     {
         if ( /^(top|bottom)-/.test(position) ) {
@@ -25,6 +35,16 @@ export class PicoDomPopover
         }
     }
 
+    /**
+     * Calculate vertical popover position
+     *
+     * @example Dom.find(".popover").popoverY(".target", "bottom-center")
+     *
+     * @param {any} target Target element
+     * @param {string} [position] Popover position
+     * @param {any} [options] Popover options
+     * @returns {any} Position result
+     */
     popoverY(target : any, position : string = 'bottom-center', options : any = {}) : any
     {
         target = Dom.find(target);
@@ -120,6 +140,16 @@ export class PicoDomPopover
         return { ...result, position };
     }
 
+    /**
+     * Calculate horizontal popover position
+     *
+     * @example Dom.find(".popover").popoverX(".target", "left-center")
+     *
+     * @param {any} target Target element
+     * @param {string} [position] Popover position
+     * @param {any} [options] Popover options
+     * @returns {any} Position result
+     */
     popoverX(target : any, position : string = 'left-center', options : any = {}) : any
     {
         target = Dom.find(target);
@@ -199,6 +229,15 @@ export class PicoDomPopover
         return { ...result, position };
     }
 
+    /**
+     * Normalize popover position
+     *
+     * @param {any} offset Current offset
+     * @param {any} self Popover size
+     * @param {any} rect Target rect
+     * @param {any} win Window size
+     * @returns {any} Normalized position
+     */
     popoverNormalize(offset : any, self : any, rect : any, win : any)
     {
         const scroll = Dom.find(document.body).scroll();

package/src/dom/DomRectangle.ts

@@ -32,6 +32,14 @@ export class PicoDomRectangle
         return Mix.num(value, 0);
     }
 
+    /**
+     * Get bounding rectangle
+     *
+     * @example Dom.find("div").rect()
+     *
+     * @param {any} [fallback] Fallback value
+     * @returns {any} Rect object
+     */
     rect(fallback : any = { left: 0, top: 0, width: 0, height: 0 })
     {
         if ( !this.el.getBoundingClientRect ) {

package/src/format/FormatFile.ts

@@ -1,5 +1,4 @@
-import { Mix, Obj, Num } from "../index.esm.ts";
-import { PicoFormat } from "../utils/Format.ts";
+import { Mix, Num } from "../index.esm.ts";
 
 export const FILE_UNITS = [
     'B', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'

package/src/format/FormatOption.ts

@@ -1,5 +1,4 @@
 import { Arr, For, Mix, Obj } from "../index.esm.ts";
-import { PicoFormat } from "../utils/Format.ts";
 
 export const OPTION_REGEX = {
     entry: /(^|;)(\s*(?<key>.*?)\s*:\s*(?<val>".*?"|'.*?'|.*?)\s*)(?=;|$)/g

package/src/format/FormatParam.ts

@@ -1,5 +1,4 @@
 import { Arr, Mix, Obj, For } from "../index.esm.ts";
-import { PicoFormat } from "../utils/Format.ts";
 
 export const PARAM_REGEX = {
     entry: /(?<=^|&|\?)(\s*(?<key>.*?)\s*=\s*(?<val>".*?"|'.*?'|.*?)\s*)(?=&|$)/g

package/src/now/NowDefault.ts

@@ -401,100 +401,148 @@ export class PicoNowDefault
 
 }
 
+/**
+ * @deprecated use Now.add instead
+ */
 // @ts-ignore
-PicoNowDefault.prototype.addSecond = function (value : any) {
+PicoNowDefault.prototype.addSecond = function(value : any) : PicoNow {
     console.warn('Now.addSecond() is deprecated, use Now.add(value, \'second\') instead.');
     return this.add(value, 'second');
-}
+};
 
+/**
+ * @deprecated use Now.sub instead
+ */
 // @ts-ignore
-PicoNowDefault.prototype.subSecond = function (value : any) {
+PicoNowDefault.prototype.subSecond = function(value : any) : PicoNow {
     console.warn('Now.subSecond() is deprecated, use Now.sub(value, \'second\') instead.');
     return this.sub(value, 'second');
-}
+};
 
+/**
+ * @deprecated use Now.add instead
+ */
 // @ts-ignore
-PicoNowDefault.prototype.addMinute = function (value : any) {
+PicoNowDefault.prototype.addMinute = function(value : any) : PicoNow {
     console.warn('Now.addMinute() is deprecated, use Now.add(value, \'minute\') instead.');
     return this.add(value, 'minute');
-}
+};
 
+/**
+ * @deprecated use Now.sub instead
+ */
 // @ts-ignore
-PicoNowDefault.prototype.subMinute = function (value : any) {
+PicoNowDefault.prototype.subMinute = function(value : any) : PicoNow {
     console.warn('Now.subMinute() is deprecated, use Now.sub(value, \'minute\') instead.');
     return this.sub(value, 'minute');
-}
+};
 
+/**
+ * @deprecated use Now.add instead
+ */
 // @ts-ignore
-PicoNowDefault.prototype.addHour = function (value : any) {
+PicoNowDefault.prototype.addHour = function(value : any) : PicoNow {
     console.warn('Now.addHour() is deprecated, use Now.add(value, \'hour\') instead.');
     return this.add(value, 'hour');
-}
+};
 
+/**
+ * @deprecated use Now.sub instead
+ */
 // @ts-ignore
-PicoNowDefault.prototype.subHour = function (value : any) {
+PicoNowDefault.prototype.subHour = function(value : any) : PicoNow {
     console.warn('Now.subHour() is deprecated, use Now.sub(value, \'hour\') instead.');
     return this.sub(value, 'hour');
-}
+};
 
+/**
+ * @deprecated use Now.add instead
+ */
 // @ts-ignore
-PicoNowDefault.prototype.addDates = function (value : any) {
+PicoNowDefault.prototype.addDates = function(value : any) : PicoNow {
     console.warn('Now.addDates() is deprecated, use Now.add(value, \'date\') instead.');
     return this.add(value, 'date');
-}
+};
 
+/**
+ * @deprecated use Now.sub instead
+ */
 // @ts-ignore
-PicoNowDefault.prototype.subDates = function (value : any) {
+PicoNowDefault.prototype.subDates = function(value : any) : PicoNow {
     console.warn('Now.subDates() is deprecated, use Now.sub(value, \'date\') instead.');
     return this.sub(value, 'date');
-}
+};
 
+/**
+ * @deprecated use Now.add instead
+ */
 // @ts-ignore
-PicoNowDefault.prototype.addMonths = function (value : any) {
+PicoNowDefault.prototype.addMonths = function(value : any) : PicoNow {
     console.warn('Now.addMonths() is deprecated, use Now.add(value, \'month\') instead.');
     return this.add(value, 'month');
-}
+};
 
+/**
+ * @deprecated use Now.sub instead
+ */
 // @ts-ignore
-PicoNowDefault.prototype.subMonths = function (value : any) {
+PicoNowDefault.prototype.subMonths = function(value : any) : PicoNow {
     console.warn('Now.subMonths() is deprecated, use Now.sub(value, \'month\') instead.');
     return this.sub(value, 'month');
-}
+};
 
+/**
+ * @deprecated use Now.add instead
+ */
 // @ts-ignore
-PicoNowDefault.prototype.addYears = function (value : any) {
+PicoNowDefault.prototype.addYears = function(value : any) : PicoNow {
     console.warn('Now.addYears() is deprecated, use Now.add(value, \'year\') instead.');
     return this.add(value, 'year');
-}
+};
 
+/**
+ * @deprecated use Now.sub instead
+ */
 // @ts-ignore
-PicoNowDefault.prototype.subYears = function (value : any) {
+PicoNowDefault.prototype.subYears = function(value : any) : PicoNow {
     console.warn('Now.subYears() is deprecated, use Now.sub(value, \'year\') instead.');
     return this.sub(value, 'year');
-}
+};
 
+/**
+ * @deprecated use Now.add instead
+ */
 // @ts-ignore
-PicoNowDefault.prototype.addDecades = function (value : any) {
+PicoNowDefault.prototype.addDecades = function(value : any) : PicoNow {
     console.warn('Now.addDecades() is deprecated, use Now.grid(10 * value, \'year\') instead.');
     return this.add(10 * value, 'year');
-}
+};
 
+/**
+ * @deprecated use Now.sub instead
+ */
 // @ts-ignore
-PicoNowDefault.prototype.subDecades = function (value : any) {
+PicoNowDefault.prototype.subDecades = function(value : any) : PicoNow {
     console.warn('Now.subDecades() is deprecated, use Now.grid(10 * value, \'year\') instead.');
     return this.sub(10 * value, 'year');
-}
+};
 
+/**
+ * @deprecated use Now.day instead
+ */
 // @ts-ignore
-PicoNowDefault.prototype.humanDay = function () {
+PicoNowDefault.prototype.humanDay = function() : number {
     console.warn('Now.humanDay() is deprecated, use Now.day() instead.');
     return this.day();
-}
+};
 
+/**
+ * @deprecated use Now.month instead
+ */
 // @ts-ignore
-PicoNowDefault.prototype.humanMonth = function () {
+PicoNowDefault.prototype.humanMonth = function() : number {
     console.warn('Now.humanMonth() is deprecated, use Now.month() instead.');
     return this.month();
-}
+};
 
 export default PicoNowDefault;

package/src/now/NowGrid.ts

@@ -197,40 +197,58 @@ export class PicoNowGrid
 
 }
 
+/**
+ * @deprecated use Now.grid instead
+ */
 // @ts-ignore
-PicoNowGrid.prototype.getYears = function () {
+PicoNowGrid.prototype.getYears = function() : Array<PicoNowInterface> {
     console.warn('Now.getYears() is deprecated, use Now.grid(\'years\') instead.');
     return this.grid('years');
-}
+};
 
+/**
+ * @deprecated use Now.grid instead
+ */
 // @ts-ignore
-PicoNowGrid.prototype.getMonths = function () {
+PicoNowGrid.prototype.getMonths = function() : Array<PicoNowInterface> {
     console.warn('Now.getMonths() is deprecated, use Now.grid(\'months\') instead.');
     return this.grid('months');
-}
+};
 
+/**
+ * @deprecated use Now.grid instead
+ */
 // @ts-ignore
-PicoNowGrid.prototype.getDates = function () {
+PicoNowGrid.prototype.getDates = function() : Array<PicoNowInterface> {
     console.warn('Now.getDates() is deprecated, use Now.grid(\'dates\') instead.');
     return this.grid('dates');
-}
+};
 
+/**
+ * @deprecated use Now.grid instead
+ */
 // @ts-ignore
-PicoNowGrid.prototype.getHours = function () {
+PicoNowGrid.prototype.getHours = function() : Array<PicoNowInterface> {
     console.warn('Now.getHours() is deprecated, use Now.grid(\'hours\') instead.');
     return this.grid('hours');
-}
+};
 
+/**
+ * @deprecated use Now.grid instead
+ */
 // @ts-ignore
-PicoNowGrid.prototype.getMinutes = function () {
+PicoNowGrid.prototype.getMinutes = function() : Array<PicoNowInterface> {
     console.warn('Now.getMinutes() is deprecated, use Now.grid(\'minutes\') instead.');
     return this.grid('minutes');
-}
+};
 
+/**
+ * @deprecated use Now.grid instead
+ */
 // @ts-ignore
-PicoNowGrid.prototype.getSeconds = function () {
+PicoNowGrid.prototype.getSeconds = function() : Array<PicoNowInterface> {
     console.warn('Now.getSeconds() is deprecated, use Now.grid(\'seconds\') instead.');
     return this.grid('seconds');
-}
+};
 
 export default PicoNowGrid;

package/src/now/NowMatch.ts

@@ -1,4 +1,4 @@
-import { Mix, Now, Obj } from "../index.esm.ts";
+import { Now } from "../index.esm.ts";
 import { PicoNow, PicoNowInterface } from "../utils/Now.ts";
 import PicoNowFormat from "./NowFormat.js";
 

package/src/now/NowRange.ts

@@ -54,10 +54,13 @@ export class PicoNowRange
 
 }
 
+/**
+ * @deprecated use Now.range instead
+ */
 // @ts-ignore
-PicoNowRange.prototype.getDatesRange = function (...args:Parameters<typeof PicoNowRange.range>) {
+PicoNowRange.prototype.getDatesRange = function(...args:Parameters<typeof PicoNowRange.prototype.range>) : Array<PicoNow> {
     console.warn('Now.getDatesRange() is deprecated, use Now.range() instead.');
     return this.range(...args);
-}
+};
 
 export default PicoNowRange;

package/src/now/NowWalker.ts

@@ -1,4 +1,3 @@
-import { Mix, Now, Obj } from "../index.esm.ts";
 import { PicoNow, PicoNowInterface } from "../utils/Now.ts";
 import PicoNowDefault from "./NowDefault.js";
 

package/src/tool/scope.ts

@@ -105,6 +105,12 @@ export function device() : void
     scope.piudv = result;
 }
 
+/**
+ * Trait multiple classes
+ *
+ * @param {any[]} values Class array
+ * @returns {any} Traited class
+ */
 export function trait(values : any[]) {
 
     const traited : any = values[0];