node-marquee - npm Package Compare versions

Comparing version 1.0.9 to 1.0.10

dist/index.js

@@ -13,10 +13,10 @@ "use strict";
 /**
- * @typedef NodeMarqueeProp
- * @property {string|HTMLElement} [prop.selector=.marquee] The selector of the element or the elements itself.
- * @property {number} [prop.speed=1] The amount of pixels to move with each frame.
- * @property {boolean} [prop.autoplay=true] If you want the marquee element to start moving after its initializing.
+ * @typedef Prop
+ * @property {string|HTMLElement} [selector=.node-marquee] The selector of the element or the elements itself.
+ * @property {number} [speed=1] The amount of pixels to move with each frame.
+ * @property {boolean} [autoplay=true] If you want the marquee element to start moving after its initializing.
  */
 
 /**
- * @typedef NodeMarqueeReturns
+ * @typedef Returns
  * @property {Function} play
@@ -30,4 +30,4 @@ * @property {Function} pause
  * Custom Marquee element with JavaScript.
- * @param {NodeMarqueeProp} prop 
- * @returns {NodeMarqueeReturns} Returns a set of methods.
+ * @param {Prop} prop 
+ * @returns {Returns} Returns a set of methods.
  */
@@ -34,0 +34,0 @@ function nodeMarquee() {

dist/types/types.d.ts

@@ -1,15 +0,20 @@
-/**
- * @typedef NodeMarqueeProp
- * @property {string|HTMLElement} [prop.selector=.marquee] The selector of the element or the elements itself.
- * @property {number} [prop.speed=1] The amount of pixels to move with each frame.
- * @property {boolean} [prop.autoplay=true] If you want the marquee element to start moving after its initializing.
+export = nodeMarquee;
+
/**
+ * @typedef Prop
+ * @property {string|HTMLElement} [selector=.node-marquee] The selector of the element or the elements itself.
+ * @property {number} [speed=1] The amount of pixels to move with each frame.
+ * @property {boolean} [autoplay=true] If you want the marquee element to start moving after its initializing.
  */
-declare type NodeMarqueeProp = {};
+declare type Prop = {
+    selector?: string | HTMLElement;
+    speed?: number;
+    autoplay?: boolean;
+};
 
 /**
- * @typedef NodeMarqueeReturns
+ * @typedef Returns
  * @property {Function} play
  * @property {Function} pause
  */
-declare type NodeMarqueeReturns = {
+declare type Returns = {
     play: (...params: any[]) => any;
@@ -23,6 +28,6 @@ pause: (...params: any[]) => any;
  * Custom Marquee element with JavaScript.
- * @param {NodeMarqueeProp} prop
- * @returns {NodeMarqueeReturns} Returns a set of methods.
+ * @param {Prop} prop
+ * @returns {Returns} Returns a set of methods.
  */
-declare function nodeMarquee(prop: NodeMarqueeProp): NodeMarqueeReturns;
+declare function nodeMarquee(prop: Prop): Returns;
 

package.json

 {
   "name": "node-marquee",
-  "version": "1.0.9",
+  "version": "1.0.10",
   "description": "Custom Marquee element with JavaScript",
@@ -13,3 +13,3 @@ "main": "dist/index.js",
     "docs:default": "./node_modules/.bin/jsdoc -c jsdoc/jsdoc.json -R README.md",
-    "docs:types": "./node_modules/.bin/jsdoc -c jsdoc/jsdoc.types.json",
+    "docs:types": "./node_modules/.bin/jsdoc -c jsdoc/jsdoc.types.json && node jsdoc/exportJsDoc.js",
     "prepare": "npm version patch && npm run prepare:cjs && npm run docs && npm run build",
@@ -16,0 +16,0 @@ "prepare:cjs": "NODE_ENV=cjs babel ./src --out-dir ./dist",

No alert changes

Improved metrics

Lines of code

1249

increased by0.4%

Worsened metrics

Total package byte prevSize

637529

decreased by-0.05%

No dependency changes