Skip to main content

Interface: PluginUsageOptions

Token usage configuration including limit rules and hooks.

Properties​

limits?​

optional limits: TokenLimitConfig;

Limit rules to enforce via the token ledger.


onLimitReached()?​

optional onLimitReached: (payload) => void | Promise<void>;

Hook fired when limit breaches occur.

Parameters​

ParameterType
payloadUsageLimitEvent

Returns​

void | Promise<void>


onRecorded()?​

optional onRecorded: (payload) => void | Promise<void>;

Hook fired after usage is recorded.

Parameters​

ParameterType
payloadUsageRecordedEvent

Returns​

void | Promise<void>