Open Cap Table Protocol Canton SDK - v0.2.224
    Preparing search index...

    Interface MintWithRateLimitOptions

    Options for mintWithRateLimit operation.

    interface MintWithRateLimitOptions {
        maxWaitMs?: number;
        minPollIntervalMs?: number;
        onBeforeMint?: () => void;
        onWaitStart?: (waitMs: number) => void;
        signal?: AbortSignal;
    }

    Hierarchy (View Summary)

    Index

    Properties

    maxWaitMs? minPollIntervalMs? onBeforeMint? onWaitStart? signal?

    Properties

    maxWaitMs?: number

    Maximum time to wait in milliseconds before giving up.

    300000 (5 minutes)
    minPollIntervalMs?: number

    Minimum polling interval in milliseconds when rate limited. The actual wait will use the calculated waitMs from canMintCouponsNow, but this sets a minimum interval between checks.

    100
    onBeforeMint?: () => void

    Callback invoked just before the mint function is called. Useful for logging or updating UI.

    onWaitStart?: (waitMs: number) => void

    Optional callback invoked when waiting starts, providing the estimated wait time. Useful for logging or updating UI.

    signal?: AbortSignal

    Signal to abort the wait operation. If the signal is aborted, the promise will reject with an AbortError.

    Settings

    Member Visibility

    On This Page

    Properties