rekapi - npm Package Compare versions

Comparing version 2.0.4 to 2.0.5

package.json

 {
   "name": "rekapi",
-  "version": "2.0.4",
+  "version": "2.0.5",
   "homepage": "http://rekapi.com",
@@ -17,5 +17,7 @@ "author": "Jeremy Kahn <[e-mail]>",
   "devDependencies": {
+    "@jeremyckahn/minami": "^1.3.0",
     "babel-core": "^6.22.1",
     "babel-loader": "^6.2.10",
     "babel-preset-es2015": "^6.22.0",
+    "concurrently": "^3.5.0",
     "gh-pages": "^1.0.0",
@@ -27,3 +29,3 @@ "jquery": "^3.2.1",
     "jshint": "^2.9.4",
-    "minami": "^1.2.3",
+    "live-server": "^1.2.0",
     "mocha": "^3.2.0",
@@ -41,2 +43,5 @@ "nodemon": "^1.11.0",
     "doc": "jsdoc -c .jsdoc src/*.js src/renderers/*.js",
+    "doc:view": "live-server dist/doc --port=9124",
+    "doc:watch": "nodemon --exec \"npm run doc\" --watch src --watch ./ --ext js,md --ignore dist",
+    "doc:live": "concurrently --kill-others \"npm run doc:watch\" \"npm run doc:view\"",
     "lint": "jshint src",
@@ -43,0 +48,0 @@ "deploy": "npm run build && npm run doc && gh-pages -d dist -b gh-pages",

README.md

@@ -49,2 +49,8 @@ # Rekapi - Keyframes for JavaScript
 
+To generate, live-update, and view the documentation in your browser:
+
+```
+npm run doc:live
+```
+
 To start a development server:
@@ -51,0 +57,0 @@

src/actor.js

@@ -955,3 +955,3 @@ import _, { noop } from 'lodash';
    * @method rekapi.Actor#exportTimeline
-   * @return {Object} This data can later be consumed by {@link
+   * @return {rekapi.actorData} This data can later be consumed by {@link
    * rekapi.Actor#importTimeline}.
@@ -983,6 +983,5 @@ */
    * keyframe properties before importing new ones.
-   *
    * @method rekapi.Actor#importTimeline
-   * @param {Object} actorData Any object that has the same data format as the
-   * object generated from {@link rekapi.Actor#exportTimeline}.
+   * @param {rekapi.actorData} actorData Any object that has the same data
+   * format as the object generated from {@link rekapi.Actor#exportTimeline}.
    */
@@ -989,0 +988,0 @@ importTimeline (actorData) {

src/keyframe-property.js

@@ -170,3 +170,3 @@ import _ from 'lodash';
    * @method rekapi.KeyframeProperty#exportPropertyData
-   * @return {Object}
+   * @return {rekapi.propertyData}
    */
@@ -173,0 +173,0 @@ exportPropertyData () {

src/main.js

@@ -13,2 +13,39 @@ /**
 /**
+ * @typedef {Object} rekapi.propertyData
+ * @property {number|string} value
+ * @property {number} millisecond
+ * @property {string} easing
+ * @property {string} name
+ */
+
+/**
+ * @typedef {Object} rekapi.actorData
+ * @property {Array.<string>} trackNames The values of this array must
+ * correspond 1:1 to the key names in `propertyTracks`.
+ * @property {Object.<Array.<rekapi.propertyData>>} propertyTracks
+ * @property {number} end
+ * @property {number} start
+ */
+
+/**
+ * The properties of this object are used as arguments provided to
+ * [`shifty.setBezierFunction`](http://jeremyckahn.github.io/shifty/doc/shifty.html#.setBezierFunction).
+ * @typedef {Object} rekapi.curveData
+ * @property {number} x1
+ * @property {number} x2
+ * @property {number} y1
+ * @property {number} y2
+ * @property {string} displayName
+ */
+
+/**
+ * The `JSON.stringify`-friendly data format for serializing a Rekapi
+ * animation.
+ * @typedef {Object} rekapi.timelineData
+ * @property {Array.<rekapi.ActorData>} actors
+ * @property {Object.<rekapi.curveData>} curves
+ * @property {number} duration
+ */
+
+/**
  * A function that is called when an event is fired.  See {@link
@@ -15,0 +52,0 @@ * rekapi.Rekapi#on} for a list of valid events.

src/rekapi.js

@@ -731,3 +731,3 @@ import _ from 'lodash';
    * @method rekapi.Rekapi#exportTimeline
-   * @return {Object} This data can later be consumed by {@link
+   * @return {rekapi.timelineData} This data can later be consumed by {@link
    * rekapi.Rekapi#importTimeline}.
@@ -765,4 +765,4 @@ */
    * @method rekapi.Rekapi#importTimeline
-   * @param {Object} rekapiData Any object that has the same data format as the
-   * object generated from {@link rekapi.Rekapi#exportTimeline}.
+   * @param {rekapi.timelineData} rekapiData Any object that has the same data
+   * format as the object generated from {@link rekapi.Rekapi#exportTimeline}.
    */
@@ -769,0 +769,0 @@ importTimeline (rekapiData) {

No alert changes

Improved metrics

Total package byte prevSize

5251476

increased by1.22%

Lines of code

14591

increased by0.22%

Number of lines in readme file

97

increased by6.59%

Worsened metrics

Dev dependency count

17

increased by13.33%

No dependency changes