Skip to main content

@wildix/xbees-conversations-utils > withStreamRateLimitOptions

withStreamRateLimitOptions() function

Creates a marker token that can be passed as the last argument to proxied Stream methods. The proxy strips this token from original method args and uses it as per-call retry options.

Signature:

export declare function withStreamRateLimitOptions(options: Partial<StreamRateLimitRetryOptions>): StreamRateLimitOptionsToken;

Parameters

Parameter

Type

Description

options

Partial<StreamRateLimitRetryOptions>

Returns:

StreamRateLimitOptionsToken