@blackbyte/sugar 1.0.0-beta.1 → 1.0.0-beta.3

package/dist/js/dom/query/querySelectorUp.js

@@ -18,12 +18,12 @@ import matches from './matches.js';
  *
  * @example  	js
  * import { querySelectorUp } from '@blackbyte/sugar/dom'
- * const closestElm =  querySelectorUp(myCoolElement, '.my-cool-class');
+ * const closestElm =  querySelectorUp($elm, '.my-cool-class');
  * if (closestElm) {
- * 		// we have found en element that matches the selector
+ *   // we have found en element that matches the selector
  * }
  * // the selector param can be a function that need to return either true or false like so:
- *  querySelectorUp(myCoolElement, (elm) => {
+ * querySelectorUp($elm, (elm) => {
  *   return elm.hasAttribute('my-cool-attribute')
  * })
  *

package/dist/js/dom/style/getAnimationProperties.d.ts

@@ -7,7 +7,7 @@
  *
  * Get the css animation properties from an HTMLElement in an object format
  *
- * @param 		{HTMLElement} 		elm  		The element to get the properties from
+ * @param 		{HTMLElement} 		$elm  	The element to get the properties from
  * @return 		{Object} 									The animation properties
  *
  * @todo      tests
@@ -16,7 +16,7 @@
  *
  * @example  	js
  * import { getAnimationProperties } from '@blackbyte/sugar/dom'
- * const props = getAnimationProperties(myCoolHTMLElement);
+ * const props = getAnimationProperties($myCoolHTMLElement);
  * // output format
  * // {
  * // 	name : ['animation1'],

package/dist/js/dom/style/getCssDeclarations.d.ts

@@ -7,7 +7,7 @@
  *
  * Get all the CSSRules of the passed type
  *
- * @param           {string}              [typeName='style']            CSSRule type to search for, valid types: unknown, style, charset, import, media, fontface, page, keyframes, keyframe, namespace, counter, supports, document, fontfeature, viewport, region
+ * @param           {string}              [typeName=style]            CSSRule type to search for, valid types: unknown, style, charset, import, media, fontface, page, keyframes, keyframe, namespace, counter, supports, document, fontfeature, viewport, region
  * @param           {array}               [rules=[]]                    Array of CSSRules to search
  * @param           {function}            [predecate=Boolean]           Predecate function to filter matches
  * @return          {array}                                             Array of matching CSSRules

package/dist/js/dom/style/getCssDeclarations.js

@@ -7,7 +7,7 @@
  *
  * Get all the CSSRules of the passed type
  *
- * @param           {string}              [typeName='style']            CSSRule type to search for, valid types: unknown, style, charset, import, media, fontface, page, keyframes, keyframe, namespace, counter, supports, document, fontfeature, viewport, region
+ * @param           {string}              [typeName=style]            CSSRule type to search for, valid types: unknown, style, charset, import, media, fontface, page, keyframes, keyframe, namespace, counter, supports, document, fontfeature, viewport, region
  * @param           {array}               [rules=[]]                    Array of CSSRules to search
  * @param           {function}            [predecate=Boolean]           Predecate function to filter matches
  * @return          {array}                                             Array of matching CSSRules

package/dist/js/dom/style/getRotateProperties.d.ts

@@ -16,7 +16,7 @@
  *
  * @example  	js
  * import { getRotateProperties } from '@blackbyte/sugar/dom'
- * const props = getRotateProperties(myCoolHTMLElement);
+ * const props = getRotateProperties($myCoolHTMLElement);
  * // output format
  * // {
  * // 	x : 100,

package/dist/js/dom/style/getRotateProperties.js

@@ -17,7 +17,7 @@ import * as rematrix from 'rematrix';
  *
  * @example  	js
  * import { getRotateProperties } from '@blackbyte/sugar/dom'
- * const props = getRotateProperties(myCoolHTMLElement);
+ * const props = getRotateProperties($myCoolHTMLElement);
  * // output format
  * // {
  * // 	x : 100,

package/dist/js/dom/style/getScaleProperty.d.ts

@@ -16,7 +16,7 @@
  *
  * @example  	js
  * import { getScaleProperty } from '@blackbyte/sugar/dom'
- * const props = getScaleProperty(myCoolHTMLElement);
+ * const props = getScaleProperty($myCoolHTMLElement);
  * // output format
  * // 2
  *

package/dist/js/dom/style/getStyleProperty.d.ts

@@ -9,7 +9,7 @@
  * This function try to store the actual style to not trigger more that 1 redraw
  * each js execution loop.
  *
- * @param 		{HTMLElement} 					elm  		      The element to get style from
+ * @param 		{HTMLElement} 					$elm  		    The element to get style from
  * @param 		{String} 						    property 	    The css property to get
  * @return 		{Mixed} 									            The style value
  *
@@ -19,7 +19,7 @@
  *
  * @example  	js
  * import { getStyleProperty } from '@blackbyte/sugar/dom'
- * const opacity = getStyleProperty(myCoolHTMLElement, 'opacity');
+ * const opacity = getStyleProperty($myCoolHTMLElement, 'opacity');
  *
  * @see 		https://developer.mozilla.org/en-US/docs/Web/API/Window/getComputedStyle
  * @since           1.0.0

package/dist/js/dom/style/getStyleProperty.js

@@ -11,7 +11,7 @@ import parse from '../../../shared/string/parse.js';
  * This function try to store the actual style to not trigger more that 1 redraw
  * each js execution loop.
  *
- * @param 		{HTMLElement} 					elm  		      The element to get style from
+ * @param 		{HTMLElement} 					$elm  		    The element to get style from
  * @param 		{String} 						    property 	    The css property to get
  * @return 		{Mixed} 									            The style value
  *
@@ -21,7 +21,7 @@ import parse from '../../../shared/string/parse.js';
  *
  * @example  	js
  * import { getStyleProperty } from '@blackbyte/sugar/dom'
- * const opacity = getStyleProperty(myCoolHTMLElement, 'opacity');
+ * const opacity = getStyleProperty($myCoolHTMLElement, 'opacity');
  *
  * @see 		https://developer.mozilla.org/en-US/docs/Web/API/Window/getComputedStyle
  * @since           1.0.0

package/dist/js/dom/style/getTransformProperties.d.ts

@@ -16,12 +16,12 @@
  *
  * @example  	js
  * import { getTransformProperties } from '@blackbyte/sugar/dom'
- * const props = getTransformProperties(myCoolHTMLElement);
+ * const props = getTransformProperties($myCoolHTMLElement);
  * // output format
  * // {
- * // 	translateX : 100,
- * // 	translateY : 0,
- * // 	translateZ : 0,
+ * //   translateX : 100,
+ * //   translateY : 0,
+ * //   translateZ : 0,
  * //   rotateX: 0,
  * //   rotateY: 0,
  * //   rotateZ: 0

package/dist/js/dom/style/getTransitionProperties.d.ts

@@ -7,7 +7,7 @@
  *
  * Get the css transition properties from an HTMLElement in an object format
  *
- * @param 		{HTMLElement} 					elm  		The element to get the properties from
+ * @param 		{HTMLElement} 					$elm  		The element to get the properties from
  * @return 		{Object} 									      The transition properties
  *
  * @todo      tests
@@ -16,7 +16,7 @@
  *
  * @example  	js
  * import { getTransitionProperties } from '@blackbyte/sugar/dom'
- * const props = getTransitionProperties(myCoolHTMLElement);
+ * const props = getTransitionProperties($myCoolHTMLElement);
  * // output format
  * // {
  * // 	property : ['all'],

package/dist/js/dom/style/getTranslateProperties.d.ts

@@ -16,7 +16,7 @@
  *
  * @example  	js
  * import { getTranslateProperties } from '@blackbyte/sugar/dom'
- * const props = getTranslateProperties(myCoolHTMLElement);
+ * const props = getTranslateProperties($myCoolHTMLElement);
  * // output format
  * // {
  * // 	x : 100,

package/dist/js/dom/when/whenAnimationEnd.d.ts

@@ -13,7 +13,7 @@
  *
  * @snippet         whenAnimationEnd($1)
  * whenAnimationEnd($1).then(\$elm => {
- *      $2
+ *   $2
  * });
  *
  * @todo      tests
@@ -21,7 +21,7 @@
  * @example    js
  * import { whenAnimationEnd } from '@blackbyte/sugar/dom'
  * whenAnimationEnd(myCoolElm).then(($elm) => {
- *      // do something...
+ *   // do something...
  * });
  *
  * @since           1.0.0

package/dist/js/dom/when/whenAnimationEnd.js

@@ -13,7 +13,7 @@
  *
  * @snippet         whenAnimationEnd($1)
  * whenAnimationEnd($1).then(\$elm => {
- *      $2
+ *   $2
  * });
  *
  * @todo      tests
@@ -21,7 +21,7 @@
  * @example    js
  * import { whenAnimationEnd } from '@blackbyte/sugar/dom'
  * whenAnimationEnd(myCoolElm).then(($elm) => {
- *      // do something...
+ *   // do something...
  * });
  *
  * @since           1.0.0

package/dist/js/dom/when/whenAttribute.d.ts

@@ -19,7 +19,7 @@
  *
  * @snippet         whenAttribute($1, $2)
  * whenAttribute($1, $2).then(value => {
- *      $3
+ *   $3
  * });
  *
  * @todo      tests
@@ -28,18 +28,18 @@
  * import { whenAttribute } from '@blackbyte/sugar/dom'
  *
  * // using promise
- * whenAttribute(myCoolHTMLElement, 'value').then(value => {
- *      // do something...
+ * whenAttribute($myCoolHTMLElement, 'value').then(value => {
+ *   // do something...
  * });
  *
  * // with a check function
- * whenAttribute(myCoolHTMLElement, 'value', {
- *    check(newVal, oldVal) {
- * 	      // make sure the value is a number
- * 		  return typeof(newVal) === 'number';
- *    }
+ * whenAttribute($myCoolHTMLElement, 'value', {
+ *   check(newVal, oldVal) {
+ *    // make sure the value is a number
+ *    return typeof(newVal) === 'number';
+ *   }
  * }).then(value => {
- *      // do something...
+ *   // do something...
  * });
  *
  * @since           1.0.0

package/dist/js/dom/when/whenDomReady.d.ts

@@ -13,7 +13,7 @@
  *
  * @snippet         whenDomReady()
  * whenDomReady().then(() => {
- *      $1
+ *   $1
  * });
  *
  * @todo      tests
@@ -21,7 +21,7 @@
  * @example  	js
  * import { whenDomReady } from '@blackbyte/sugar/dom'
  * whenDomReady().then(() => {
- *     // do something...
+ *   // do something...
  * });
  *
  * @see             https://www.jstips.co/en/javascript/detect-document-ready-in-pure-js/

package/dist/js/dom/when/whenDomReady.js

@@ -13,7 +13,7 @@
  *
  * @snippet         whenDomReady()
  * whenDomReady().then(() => {
- *      $1
+ *   $1
  * });
  *
  * @todo      tests
@@ -21,7 +21,7 @@
  * @example  	js
  * import { whenDomReady } from '@blackbyte/sugar/dom'
  * whenDomReady().then(() => {
- *     // do something...
+ *   // do something...
  * });
  *
  * @see             https://www.jstips.co/en/javascript/detect-document-ready-in-pure-js/

package/dist/js/dom/when/whenEntersViewport.d.ts

@@ -19,7 +19,7 @@
  *
  * @snippet         whenEntersViewport($1)
  * whenEntersViewport($1).then(\$elm => {
- *      $2
+ *   $2
  * });
  *
  * @todo      tests
@@ -27,7 +27,7 @@
  * @example 	js
  * import { whenEntersViewport } from '@blackbyte/sugar/dom'
  * whenEntersViewport($myElement).then(($elm) => {
- * 		// do something with your element that has entered the viewport...
+ *   // do something with your element that has entered the viewport...
  * });
  *
  * @since           1.0.0

package/dist/js/dom/when/whenEventListener.d.ts

@@ -15,15 +15,15 @@
  *
  * @snippet         whenEventListener($1, $2)
  * whenEventListener($1, $2).then(e: Event => {
- *      $3
+ *   $3
  * });
  *
  * @todo      tests
  *
  * @example    js
  * import { whenEventListener } from '@blackbyte/sugar/dom'
- * whenEventListener('click', myCoolElm).then((e: Event) => {
- *      // do something...
+ * whenEventListener('click', $elm).then((e: Event) => {
+ *   // do something...
  * });
  *
  * @since           1.0.0

package/dist/js/dom/when/whenEventListener.js

@@ -15,15 +15,15 @@
  *
  * @snippet         whenEventListener($1, $2)
  * whenEventListener($1, $2).then(e: Event => {
- *      $3
+ *   $3
  * });
  *
  * @todo      tests
  *
  * @example    js
  * import { whenEventListener } from '@blackbyte/sugar/dom'
- * whenEventListener('click', myCoolElm).then((e: Event) => {
- *      // do something...
+ * whenEventListener('click', $elm).then((e: Event) => {
+ *   // do something...
  * });
  *
  * @since           1.0.0

package/dist/js/dom/when/whenIframeReady.d.ts

@@ -13,7 +13,7 @@
  *
  * @snippet         whenIframeReady($1)
  * whenIframeReady($1).then(\$elm => {
- *      $2
+ *   $2
  * });
  *
  * @todo      tests
@@ -21,7 +21,7 @@
  * @example  	js
  * import { whenIframeReady } from '@blackbyte/sugar/dom'
  * whenIframeReady($myCoolIframe).then($iframe => {
- *      // do something...
+ *   // do something...
  * });
  *
  * @since           1.0.0

package/dist/js/dom/when/whenIframeReady.js

@@ -13,7 +13,7 @@
  *
  * @snippet         whenIframeReady($1)
  * whenIframeReady($1).then(\$elm => {
- *      $2
+ *   $2
  * });
  *
  * @todo      tests
@@ -21,7 +21,7 @@
  * @example  	js
  * import { whenIframeReady } from '@blackbyte/sugar/dom'
  * whenIframeReady($myCoolIframe).then($iframe => {
- *      // do something...
+ *   // do something...
  * });
  *
  * @since           1.0.0

package/dist/js/dom/when/whenImageLoaded.d.ts

@@ -14,15 +14,15 @@
  *
  * @snippet         whenImageLoaded($1)
  * whenImageLoaded($1).then(\$img => {
- *      $2
+ *   $2
  * });
  *
  * @todo      tests
  *
  * @example  	js
  * import { whenImageLoaded } from '@blackbyte/sugar/dom'
- *  whenImageLoaded(myCoolHTMLImageElement).then(($img) => {
- * 		// do something when the image is loaded
+ * whenImageLoaded($myCoolHTMLImageElement).then(($img) => {
+ *   // do something when the image is loaded
  * });
  *
  * @since           1.0.0

package/dist/js/dom/when/whenImageLoaded.js

@@ -14,15 +14,15 @@
  *
  * @snippet         whenImageLoaded($1)
  * whenImageLoaded($1).then(\$img => {
- *      $2
+ *   $2
  * });
  *
  * @todo      tests
  *
  * @example  	js
  * import { whenImageLoaded } from '@blackbyte/sugar/dom'
- *  whenImageLoaded(myCoolHTMLImageElement).then(($img) => {
- * 		// do something when the image is loaded
+ * whenImageLoaded($myCoolHTMLImageElement).then(($img) => {
+ *   // do something when the image is loaded
  * });
  *
  * @since           1.0.0

package/dist/js/dom/when/whenImagesLoaded.d.ts

@@ -16,7 +16,7 @@
  *
  * @snippet         whenImagesLoaded($1)
  * whenImagesLoaded($1).then(imgs => {
- *      $2
+ *   $2
  * });
  *
  * @todo      tests
@@ -25,9 +25,7 @@
  * import { whenImagesLoaded } from '@blackbyte/sugar/dom'
  * whenImagesLoaded([
  * 	$img1, $img2, $img3
- * ]).on('loaded', $img => {
- *    // do something with the loaded image
- * }).then(imgs => {
+ * ]).then(imgs => {
  *   // do something here
  * })
  *

package/dist/js/dom/when/whenImagesLoaded.js

@@ -17,7 +17,7 @@ import whenImageLoaded from './whenImageLoaded.js';
  *
  * @snippet         whenImagesLoaded($1)
  * whenImagesLoaded($1).then(imgs => {
- *      $2
+ *   $2
  * });
  *
  * @todo      tests
@@ -26,9 +26,7 @@ import whenImageLoaded from './whenImageLoaded.js';
  * import { whenImagesLoaded } from '@blackbyte/sugar/dom'
  * whenImagesLoaded([
  * 	$img1, $img2, $img3
- * ]).on('loaded', $img => {
- *    // do something with the loaded image
- * }).then(imgs => {
+ * ]).then(imgs => {
  *   // do something here
  * })
  *

package/dist/js/dom/when/whenImagesLoaded.js.map

@@ -1 +1 @@
-{"version":3,"file":"whenImagesLoaded.js","sourceRoot":"","sources":["../../../../src/js/dom/when/whenImagesLoaded.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,MAAM,sBAAsB,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CACtC,KAAyB;IAEzB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,QAAQ,GAAgC,EAAE,EAC9C,YAAY,GAAuB,EAAE,CAAC;QAExC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACjC,MAAM,GAAG,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;YAClC,GAAG;iBACA,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;gBACd,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACzB,IAAI,YAAY,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,EAAE,CAAC;oBACzC,OAAO,CAAC,YAAY,CAAC,CAAC;gBACxB,CAAC;YACH,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACf,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC,CAAC;gBACF,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"whenImagesLoaded.js","sourceRoot":"","sources":["../../../../src/js/dom/when/whenImagesLoaded.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,MAAM,sBAAsB,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CACtC,KAAyB;IAEzB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,QAAQ,GAAgC,EAAE,EAC9C,YAAY,GAAuB,EAAE,CAAC;QAExC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACjC,MAAM,GAAG,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;YAClC,GAAG;iBACA,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;gBACd,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACzB,IAAI,YAAY,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,EAAE,CAAC;oBACzC,OAAO,CAAC,YAAY,CAAC,CAAC;gBACxB,CAAC;YACH,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACf,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC,CAAC;gBACF,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/js/dom/when/whenInViewport.d.ts

@@ -19,15 +19,15 @@
  *
  * @snippet         whenInViewport($1)
  * whenInViewport($1).then(\$elm => {
- *      $2
+ *   $2
  * });
  *
  * @todo      tests
  *
  * @example 	js
  * import { whenInViewport } from '@blackbyte/sugar/dom'
- * const promise = whenInViewport(myCoolHTMLElement).then((elm) => {
- * 		// do something with your element that has entered the viewport...
+ * const promise = whenInViewport($myCoolHTMLElement).then((elm) => {
+ *   // do something with your element that has entered the viewport...
  * });
  * // when you want to stop listening
  * promise.cancel();

package/dist/js/dom/when/whenInteract.d.ts

@@ -28,7 +28,7 @@
  *
  * @example  	js
  * import { whenInteract } from '@blackbyte/sugar/dom'
- * whenInteract(myCoolElement).then($elm => {
+ * whenInteract($elm).then($elm => {
  *      // do something...
  * });
  *

package/dist/js/dom/when/whenInteract.js

@@ -28,7 +28,7 @@
  *
  * @example  	js
  * import { whenInteract } from '@blackbyte/sugar/dom'
- * whenInteract(myCoolElement).then($elm => {
+ * whenInteract($elm).then($elm => {
  *      // do something...
  * });
  *

package/dist/js/dom/when/whenLinkLoaded.js

@@ -16,13 +16,13 @@
  *
  * @snippet         whenLinkLoaded($1)
  * whenLinkLoaded($1).then(\$elm => {
- *      $2
+ *   $2
  * });
  *
  * @example  	js
  * import { whenLinkLoaded } from '@blackbyte/sugar/dom'
- * whenLinkLoaded(myCoolHTMLLinlElement).then($link => {
- * 		// do something when the link is loaded
+ * whenLinkLoaded($myCoolHTMLLinlElement).then($link => {
+ *   // do something when the link is loaded
  * });
  *
  * @since           1.0.0

package/dist/js/dom/when/whenNearViewport.d.ts

@@ -19,15 +19,15 @@
  *
  * @snippet         whenNearViewport($1)
  * whenNearViewport($1).then(\$elm => {
- *      $2
+ *   $2
  * });
  *
  * @todo      tests
  *
  * @example 	js
  * import { whenNearViewport } from '@blackbyte/sugar/dom'
- * whenNearViewport(myCoolHTMLElement).then($elm => {
- * 		// do something with your element that has entered the viewport...
+ * whenNearViewport($myCoolHTMLElement).then($elm => {
+ *   // do something with your element that has entered the viewport...
  * });
  *
  * @since           1.0.0

package/dist/js/dom/when/whenOutOfViewport.d.ts

@@ -19,15 +19,15 @@
  *
  * @snippet         whenOutOfViewport($1)
  * whenOutOfViewport($1).then(\$$elm => {
- *      $2
+ *   $2
  * });
  *
  * @todo      tests
  *
  * @example 	js
  * import { whenOutOfViewport } from '@blackbyte/sugar/dom'
- * whenOutOfViewport(myCoolHTMLElement).then(($elm) => {
- * 		// do something with your element that has exit the viewport...
+ * whenOutOfViewport($myCoolHTMLElement).then(($elm) => {
+ *   // do something with your element that has exit the viewport...
  * });
  *
  * @since           1.0.0

package/dist/js/dom/when/whenOutOfViewport.js

@@ -19,15 +19,15 @@
  *
  * @snippet         whenOutOfViewport($1)
  * whenOutOfViewport($1).then(\$$elm => {
- *      $2
+ *   $2
  * });
  *
  * @todo      tests
  *
  * @example 	js
  * import { whenOutOfViewport } from '@blackbyte/sugar/dom'
- * whenOutOfViewport(myCoolHTMLElement).then(($elm) => {
- * 		// do something with your element that has exit the viewport...
+ * whenOutOfViewport($myCoolHTMLElement).then(($elm) => {
+ *   // do something with your element that has exit the viewport...
  * });
  *
  * @since           1.0.0

package/dist/js/dom/when/whenRemoved.d.ts

@@ -17,15 +17,15 @@
  *
  * @snippet         whenRemoved($1);
  * whenRemoved($1).then(() => {
- *      $2
+ *   $2
  * });
  *
  * @todo      tests
  *
  * @example 	js
  * import { whenRemoved } from '@blackbyte/sugar/dom'
- * whenRemoved(myCoolHTMLElement).then(() => {
- * 		// the element has been removed
+ * whenRemoved($myCoolHTMLElement).then(() => {
+ *   // the element has been removed
  * });
  *
  * @since           1.0.0

package/dist/js/dom/when/whenRemoved.js

@@ -17,15 +17,15 @@
  *
  * @snippet         whenRemoved($1);
  * whenRemoved($1).then(() => {
- *      $2
+ *   $2
  * });
  *
  * @todo      tests
  *
  * @example 	js
  * import { whenRemoved } from '@blackbyte/sugar/dom'
- * whenRemoved(myCoolHTMLElement).then(() => {
- * 		// the element has been removed
+ * whenRemoved($myCoolHTMLElement).then(() => {
+ *   // the element has been removed
  * });
  *
  * @since           1.0.0

package/dist/js/dom/when/whenStylesheetsReady.d.ts

@@ -11,8 +11,8 @@
  * @feature       Async promise based
  * @feature       Multiple stylesheets elements listening
  *
- * @param 		{Array<HTMLLinkElement>} 		    [links=null] 			The HTMLLinkElement tags to process. If not passed, take the local stylesheets links
- * @return 		{Promise<void>} 										              The promise that will be resolved when all the links are loaded
+ * @param 		{Array<HTMLLinkElement>} 		    [$links=null] 			The HTMLLinkElement tags to process. If not passed, take the local stylesheets links
+ * @return 		{Promise<void>} 										                The promise that will be resolved when all the links are loaded
  *
  * @todo      tests
  *
@@ -24,8 +24,8 @@
  * @example 	js
  * import { whenStylesheetsReady } from '@blackbyte/sugar/dom'
  * whenStylesheetsReady([
- * 		myHTMLLinkElement1,
- * 		myHTMLLinkElement2
+ * 		$myHTMLLinkElement1,
+ * 		$myHTMLLinkElement2
  * ]).then(stylesheets => {
  *      // do something...
  * });
@@ -33,4 +33,4 @@
  * @since           1.0.0
  * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
  */
-export default function whenStylesheetsReady(links?: HTMLLinkElement[]): Promise<HTMLLinkElement[]>;
+export default function whenStylesheetsReady($links?: HTMLLinkElement[]): Promise<HTMLLinkElement[]>;