async-bulkhead-llm - v3.17.0
    Preparing search index...

    Type Alias UsageReport

    async-bulkhead-llm — public API surface.

    This entry point re-exports everything the package supports; the implementation lives in focused modules:

    • types.ts — request/result/options/stats/event types
    • errors.ts — LLMBulkheadRejectedError
    • profiles.ts — PROFILES presets
    • estimators.ts — naive + model-aware estimators, extractTextLength
    • adaptive.ts — createAdaptiveTokenEstimator (v3.8)
    • dedup.ts — deduplication internals (keying, share safety)
    • validation.ts — internal numeric/estimate/usage guards
    • bulkhead.ts — createLLMBulkhead (admission, budget, events)

    Deep-importing the internal modules is not supported; the package exports map exposes only this entry point.

    type UsageReport = {
        admissionClass?: string;
        admissionId: string;
        consumed: number;
        held: number;
        limitRevision: number;
        outputCap: number | null;
        outputRemaining: number | null;
        overReservation: boolean;
        reserved: number;
        sequence: number;
    }
    Index
    admissionClass? admissionId consumed held limitRevision outputCap outputRemaining overReservation reserved sequence
    admissionClass?: string

    Bounded policy class used for this admission, when configured.

    admissionId: string

    Stable identifier of the admission this usage belongs to.

    consumed: number

    Cumulative reported consumption (input + output).

    held: number

    Tokens currently held against the budget for this request.

    limitRevision: number

    Immutable limit revision captured when this work was admitted or bypassed.

    outputCap: number | null

    Output tokens reserved for this request (max_tokens/outputCap).

    outputRemaining: number | null

    Output reservation remaining before the stream overruns it.

    overReservation: boolean

    True once cumulative consumption exceeds the original reservation.

    reserved: number

    Original pre-admission reservation (0 when budget disabled).

    sequence: number

    Last effective usage-update sequence for this admission. Starts at 0 before any effective report, increments when cumulative usage increases or the effective held-token amount changes, and remains stable for stale/no-op reports.

    Settings
    Member Visibility

    On This Page
    Properties