just_throttle_it 2.1.0

A simple throttle library for limiting consecutive execution of functions

just_throttle_it

A simple throttle library for Dart. Supports throttling by function and stream throttling.

import 'package:just_throttle_it/just_throttle_it.dart';

Throttle.milliseconds(1000, print, ["Throttle World!"]);

Static methods

There are three methods available for throttling. A value of true will be returned if the function call is successful, and false if the function has been blocked. All methods differ only by the first parameter used to specify timeout values in different formats:

Throttle.seconds(int timeoutSeconds, 
    Function target,
    [List<dynamic> positionalArguments, 
    Map<Symbol, dynamic> namedArguments])

Throttle.milliseconds(int timeoutMs, 
    Function target,
    [List<dynamic> positionalArguments, 
    Map<Symbol, dynamic> namedArguments])

Throttle.duration(Duration timeout, 
    Function target,
    [List<dynamic> positionalArguments, 
    Map<Symbol, dynamic> namedArguments])

To clear a throttled target, allowing the next throttled call to be immediately executed:

Throttle.clear(Function target)

Stream Throttling

Use ThrottleStreamTransfomer to throttle any stream by a specified duration.

ThrottleStreamTransfomer(Duration timeout)

ThrottleStreamTransfomer.seconds(int timeoutSeconds)

ThrottleStreamTransfomer.milliseconds(int timeoutMs)

Stream throttleStream(Stream input) => input.transform(ThrottleStreamTransformer.seconds(1));

Example

A quick demonstration can be found in the example directory. To run the example:

pub run example/main.dart