@meanie/angular-debounce

@meanie/angular-debounce

A simple Angular service for debouncing function calls

Installation

You can install this package using yarn or npm:

#yarn
yarn add @meanie/angular-debounce

#npm
npm install @meanie/angular-debounce --save

Include the script node_modules/@meanie/angular-debounce/release/angular-debounce.js in your build process, or add it via a <script> tag to your index.html:

<script src="node_modules/@meanie/angular-debounce/release/angular-debounce.js"></script>

Add Debounce.Service as a dependency for your app.

Usage

Include the $debounce service in your controller or component:

angular.module('App.MyModule').controller('MyController', function($debounce) => {

  function someFunction() {
    console.log('I am debounced');
  }

  //Debounce
  $debounce(someFunction, 1000);
});

The $debounce service returns a promise which will be resolved with the return value of the debounced function once the underlying timeout resolves.

Issues & feature requests

Please report any bugs, issues, suggestions and feature requests in the @meanie/angular-debounce issue tracker.

Contributing

Pull requests are welcome! If you would like to contribute to Meanie, please check out the Meanie contributing guidelines.

Credits

• Meanie logo designed by Quan-Lin Sim

License

(MIT License)

Copyright 2015-2017, Adam Reis