public class | source

TokenBucket

Handles how many tokens are available at any given time based on the configuration set and the token bucket algorithm.

Constructor Summary

Public Constructor
public	constructor(config: object) Creates a TokenBucket object.

Public Methods
public	decrementTokens(amount: integer): integer Decrements the amount of tokens available based on amount and returns the value.
public	destroy() Cleans up the interval set by the constructor.
public	getTokensRemaining(): integer Returns the currently available tokens.

Creates a TokenBucket object.

Name	Type	Attribute	Description
config	object		configuration values
config.limit	integer	optional default: 25	The max amount of tokens per incrementInterval.
config.incrementInterval	integer	optional default: 5000	The time in ms before tokens will increment.
config.increment	integer	optional default: 1	The amount of tokens that will increment each incrementInterval.

Decrements the amount of tokens available based on amount and returns the value.

Name	Type	Attribute	Description
amount	integer	optional default: 1	The number to decrement by

integer

The remaining available requests for the identifier

Cleans up the interval set by the constructor.

Returns the currently available tokens.

integer

The remaining available requests for the identifier