Circle V2 API Docs
    Preparing search index...

    Type Alias ScreenBeforeLookupInput

    type ScreenBeforeLookupInput = {
        allowlist?: readonly string[];
        chart: {
            extendContentHash: string | null;
            extendedAt: DbDate | null;
            extendRunId: ExtendRunId | null;
            runIsTerminal: boolean;
        };
        cooldown: {
            cooldownMs: number;
            lastSyncedDocuments: DbDate
            | null;
            now: Date;
        };
        failures: { count: number; lastFailedAt: DbDate
        | null };
        incoming: {
            attachmentId: string | null;
            changedAt: string | null;
            contentHash: string | null;
            noteType: string | null;
        };
    }
    Index

    Properties

    allowlist? chart cooldown failures incoming

    Properties

    allowlist?: readonly string[]

    Vendor note labels to extract; omitted admits every label, empty admits none.

    chart: {
        extendContentHash: string | null;
        extendedAt: DbDate | null;
        extendRunId: ExtendRunId | null;
        runIsTerminal: boolean;
    }

    Type Declaration

    • extendContentHash: string | null
    • extendedAt: DbDate | null
    • extendRunId: ExtendRunId | null
    • runIsTerminal: boolean

      Whether the run behind extendRunId has settled; a failed run must not read as in flight.

    cooldown: { cooldownMs: number; lastSyncedDocuments: DbDate | null; now: Date }

    Type Declaration

    • cooldownMs: number
    • lastSyncedDocuments: DbDate | null

      The episode's last_synced_documents; null (never synced) is never within cooldown.

    • now: Date
    failures: { count: number; lastFailedAt: DbDate | null }

    Failed runs of the chart's current bytes; a new content hash starts the count over.

    incoming: {
        attachmentId: string | null;
        changedAt: string | null;
        contentHash: string | null;
        noteType: string | null;
    }

    Settings

    Member Visibility

    On This Page

    Properties