rate_limiter 1.0.0

A pure dart package to apply useful rate limiting strategies on regular functions.

example/lib/main.dart

import 'package:rate_limiter/rate_limiter.dart';

void main() {
  var count = 0;

  // updates the count value by one and prints it
  void regularFunction() {
    count += 1;
    print(count);
  }

  // regularFunction get's executed 10000 times
  for (var i = 0; i < 10000; i++) {
    regularFunction();
  }

  // delays invoking `func` until after 100 milliseconds have elapsed
  // since the last time the debounced function was invoked
  final debouncedFunction = regularFunction.debounced(
    const Duration(milliseconds: 100),
  );

  // debouncedFunction prints only once even though invoked
  // 1000000 times
  for (var i = 0; i < 10000; i++) {
    debouncedFunction();
  }

  // only invokes `func` at most once per every 100 milliseconds
  final throttledFunction = regularFunction.throttled(
    const Duration(milliseconds: 100),
  );

  // throttledFunction prints ~3 times even though invoked
  // 10000 times
  for (var i = 0; i < 10000; i++) {
    throttledFunction();
  }
}