GitHub

ConsumeResult

API reference for ConsumeResult.

What a consume charged: wait delay before going on; remaining tokens are left of limit (below zero for queued reservations), and the key is back to full after reset_after. A whole remaining is an int whatever the store computed it with, as Effect's stores all give the same JavaScript number.

Attributes

AttributeTypeDescription
delayDuration
limitfloat
remainingfloat
reset_afterDuration

Functions

__init__

__init__(delay, limit, remaining, reset_after) -> None
ParameterTypeDescription
delayDuration
limitfloat
remainingfloat
reset_afterDuration