frame-throttle - npm Package Compare versions

Comparing version 1.1.0 to 2.0.1

CHANGELOG.md

@@ -6,4 +6,33 @@ # Change Log
 
-## [1.1.0 - 2016-08-23]
+## [2.0.1] - 2016-09-26
 ### Fixed
+- `package.json` was misconfigured and didn't include the correct files
+
+## [2.0.0] - 2016-09-26 [YANKED]
+### Added
+- `frame-throttle.d.ts` - a [TypeScript declaration file] for `frame-throttle.js`
+### Changed
+- Converted project to [TypeScript]
+- Renamed main file from `throttle.js` to `frame-throttle.js`
+- Moved main file from base directory to `dist` directory
+- `throttle` method is now a module member rather than the entire module.
+  This means that you must now use:
+  ```
+  // Correct
+  var throttle = require('frame-throttle').throttle;
+  ```
+  rather than
+  ```
+  // Wrong!
+  var throttle = require('frame-throttle');
+  ```
+- The throttled listener now passes its `this` context to the callback
+- The callback is now passed the arguments for the most recent call to the
+  throttled method rather than being passed the oldest arguments.
+  This only happens when `requestAnimationFrame` is present.
+### Known Issues
+- `package.json` was misconfigured and didn't include the correct files
+
+## [1.1.0] - 2016-08-23
+### Fixed
 - When [requestAnimationFrame] does not exist, call the callback immediately
@@ -24,3 +53,7 @@ and ignore further events for 1/60th of a second. Old behavior was to wait
 [requestAnimationFrame]: https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
+[TypeScript]: http://www.typescriptlang.org
+[TypeScript declaration file]: https://www.typescriptlang.org/docs/handbook/writing-declaration-files.html
 
+[2.0.1]: https://github.com/pelotoncycle/frame-throttle/compare/v1.1.0...v2.0.1
+[2.0.0]: https://github.com/pelotoncycle/frame-throttle/compare/v1.1.0...v2.0.0
 [1.1.0]: https://github.com/pelotoncycle/frame-throttle/compare/v1.0.0...v1.1.0

package.json

 {
   "name": "frame-throttle",
-  "version": "1.1.0",
-  "description": "A lightweight way to throttle events using requestAnimationFrame",
-  "main": "throttle.js",
+  "version": "2.0.1",
+  "description": "A lightweight way to throttle events and callbacks using requestAnimationFrame",
+  "main": "dist/frame-throttle.js",
+  "types": "dist/frame-throttle.d.ts",
+  "files": [
+    "README.md",
+    "dist/frame-throttle.js",
+    "dist/frame-throttle.d.ts"
+  ],
   "scripts": {
-    "test": "tape tests/*.tests.js",
-    "test-cov": "istanbul cover tape -- tests/*.tests.js",
+    "clean": "del-cli dist",
+    "lint": "npm run lint-noforce -- --force",
+    "lint-noforce": "tslint --project tsconfig.json",
+    "compile": "npm run clean && tsc",
+    "pretest": "npm run lint-noforce && npm run compile",
+    "prepublish": "npm test",
+    "test": "tape dist/tests/*.tests.js",
+    "test-cov": "npm run pretest && istanbul cover tape -- dist/tests/*.tests.js",
     "coveralls": "npm run test-cov -- --report lcovonly && cat coverage/lcov.info | coveralls"
   },
   "keywords": [
+    "callback",
     "events",
@@ -17,2 +30,3 @@ "frame",
     "requestAnimationFrame",
+    "setTimeout",
     "throttle"
@@ -31,3 +45,5 @@ ],
   "devDependencies": {
+    "@types/sinon": "^1.16.31",
     "coveralls": "^2.11.12",
+    "del-cli": "^0.2.0",
     "istanbul": "0.4.5",
@@ -38,4 +54,6 @@ "jsdom": "^9.4.1",
     "tape": "^4.6.0",
-    "tape-catch": "^1.0.6"
+    "tape-catch": "^1.0.6",
+    "tslint": "^3.15.1",
+    "typescript": "^2.0.3"
   }
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

5133

decreased by-69.38%

Dev dependency count

11

increased by57.14%

Number of package files

5

decreased by-54.55%

Lines of code

28

decreased by-90.48%

Number of medium quality alerts

1

increased byInfinity%

Number of lines in readme file

0

decreased by-100%

No dependency changes