@github/mini-throttle - npm Package Compare versions

Comparing version 1.0.7 to 2.0.0

dist/index.d.ts

@@ -1,26 +0,22 @@
-export type ThrottleOptions = {
-  /**
-   * Fire immediately on the first call.
-   */
-  start?: boolean
-  /**
-   * If true, fire as soon as `wait` has passed.
-   */
-  middle?: boolean
-  /**
-   * Cancel after the first successful call.
-   */
-  once?: boolean
+export interface ThrottleOptions {
+    /**
+     * Fire immediately on the first call.
+     */
+    start?: boolean;
+    /**
+     * Fire as soon as `wait` has passed.
+     */
+    middle?: boolean;
+    /**
+     * Cancel after the first successful call.
+     */
+    once?: boolean;
 }
-
-export function throttle<T extends unknown[]>(
-  callback: (...args: T) => unknown,
-  wait?: number,
-  opts?: ThrottleOptions
-): ((...args: T) => void) & {cancel(): void}
-
-export function debounce<T extends unknown[]>(
-  callback: (...args: T) => unknown,
-  wait?: number,
-  opts?: ThrottleOptions
-): ((...args: T) => void) & {cancel(): void}
+interface Throttler<T extends unknown[]> {
+    (...args: T): void;
+    cancel(): void;
+}
+export declare function throttle<T extends unknown[]>(callback: (...args: T) => unknown, wait?: number, { start, middle, once }?: ThrottleOptions): Throttler<T>;
+export declare function debounce<T extends unknown[]>(callback: (...args: T) => unknown, wait?: number, { start, middle, once }?: ThrottleOptions): Throttler<T>;
+export {};
+//# sourceMappingURL=index.d.ts.map

package.json

 {
   "name": "@github/mini-throttle",
-  "version": "1.0.7",
+  "version": "2.0.0",
   "description": "",
@@ -9,66 +9,32 @@ "repository": "github.com/github/mini-throttle",
   "files": [
-    "dist"
+    "dist",
+    "!dist/test",
+    "!dist/umd/test",
+    "decorators"
   ],
-  "main": "dist/index.umd.js",
-  "module": "dist/index.esm.js",
+  "main": "dist/umd/index.js",
+  "module": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "prebuild": "npm run clean && npm run lint && mkdir dist",
-    "build": "npm run build-umd && npm run build-esm && cp index.d.ts dist/index.d.ts",
-    "build-esm": "BABEL_ENV=esm babel index.js -o dist/index.esm.js && cp index.js.flow dist/index.esm.js.flow",
-    "build-umd": "BABEL_ENV=umd babel index.js -o dist/index.umd.js && cp index.js.flow dist/index.umd.js.flow",
+    "build": "npm run build-umd && npm run build-esm",
+    "build-esm": "tsc",
+    "build-umd": "tsc -m umd --outDir dist/umd",
     "clean": "rm -rf dist",
-    "lint": "github-lint",
+    "lint": "eslint --report-unused-disable-directives . --color --ext .js,.ts,.tsx && tsc --noEmit",
     "prepublishOnly": "npm run build",
-    "test": "BABEL_ENV=umd mocha --require @babel/register && npm run tsc",
-    "tsc": "tsc --noEmit test/index.ts",
+    "test": "mocha -r ts-node/register --extension ts",
     "postpublish": "npm publish --ignore-scripts --@github:registry='https://npm.pkg.github.com'"
   },
-  "babel": {
-    "env": {
-      "esm": {
-        "presets": [
-          [
-            "@babel/env",
-            {
-              "modules": false,
-              "exclude": [
-                "@babel/plugin-transform-regenerator",
-                "@babel/plugin-transform-spread",
-                "@babel/plugin-transform-destructuring",
-                "@babel/plugin-transform-parameters"
-              ]
-            }
-          ],
-          "@babel/flow"
-        ]
-      },
-      "umd": {
-        "plugins": [
-          "@babel/plugin-transform-modules-umd"
-        ],
-        "presets": [
-          [
-            "@babel/env",
-            {
-              "exclude": [
-                "@babel/plugin-transform-regenerator",
-                "@babel/plugin-transform-spread",
-                "@babel/plugin-transform-destructuring",
-                "@babel/plugin-transform-parameters"
-              ]
-            }
-          ],
-          "@babel/flow"
-        ]
-      }
-    }
-  },
   "eslintConfig": {
+    "parser": "@typescript-eslint/parser",
     "extends": [
       "plugin:github/browser",
       "plugin:github/es6",
-      "plugin:github/flow",
+      "plugin:github/typescript",
       "plugin:escompat/recommended"
     ],
+    "rules": {
+      "no-invalid-this": "off"
+    },
     "overrides": [
@@ -78,14 +44,5 @@ {
         "rules": {
-          "no-console": "off"
+          "no-console": "off",
+          "@typescript-eslint/no-empty-function": "off"
         }
-      },
-      {
-        "files": "**.ts",
-        "parser": "@typescript-eslint/parser",
-        "rules": {
-          "import/named": "off",
-          "import/namespace": "off",
-          "import/no-deprecated": "off",
-          "flowtype/require-valid-file-annotation": "off"
-        }
       }
@@ -98,16 +55,14 @@ ]
   "devDependencies": {
-    "@babel/cli": "^7.7.0",
-    "@babel/core": "^7.7.0",
-    "@babel/preset-env": "^7.7.1",
-    "@babel/preset-flow": "^7.0.0",
-    "@babel/register": "^7.7.0",
-    "@typescript-eslint/parser": "^2.6.1",
+    "@types/chai": "^4.2.11",
+    "@types/mocha": "^7.0.2",
+    "@typescript-eslint/parser": "^2.25.0",
     "chai": "^4.2.0",
-    "eslint": "^6.6.0",
-    "eslint-plugin-escompat": "^2.1.2",
-    "eslint-plugin-github": "^3.2.1",
-    "flow-bin": "^0.98.1",
-    "mocha": "^6.2.2",
-    "typescript": "^3.7.2"
+    "eslint": "^6.8.0",
+    "eslint-plugin-compat": "^3.5.1",
+    "eslint-plugin-escompat": "^1.1.0",
+    "eslint-plugin-github": "^3.4.1",
+    "mocha": "^7.1.1",
+    "ts-node": "^8.8.1",
+    "typescript": "^3.8.3"
   }
 }

README.md

@@ -56,1 +56,19 @@ # mini-throttle
 ```
+
+### TypeScript Decorators Support!
+
+This package also includes a decorator module which can be used to provide [TypeScript Decorator](https://www.typescriptlang.org/docs/handbook/decorators.html#decorators) annotations to functions.
+
+Here's an example, showing what you need to do:
+
+```typescript
+import {throttle} from '@github/mini-throttle/decorators'
+//                                           ^ note: add `/decorators` to the import to get decorators
+
+class MyClass {
+  @throttle(100, { start: false }) // <- Just like normal throttle, but you omit the callback argument
+  doThings() {
+    // `MyClass.prototype.doThings` will be throttled!
+  }
+}
+```

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

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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

14617

increased by38.97%

Dev dependency count

11

decreased by-15.38%

Number of package files

16

increased by100%

Lines of code

186

increased by38.81%

Number of lines in readme file

74

increased by32.14%

No dependency changes