IFClite TypeScript API
    Preparing search index...

    Interface FederatedEvaluateOptions

    interface FederatedEvaluateOptions {
        candidateExpressIdsByModel?: ReadonlyMap<
            string,
            Iterable<number, any, any>,
        >;
        chunkSize?: number;
        definedModelTagIds?: ReadonlySet<string>;
        limit?: number;
        listConditions?: ListConditionMatcher;
        modelFilterIdentity?: string;
        modelTagIds?: ReadonlySet<string>;
        onProgress?: (scanned: number, total: number) => void;
        predefinedTypeOf?: (expressId: number) => string;
        signal?: AbortSignal;
        storeyNameOf?: (expressId: number) => string;
    }

    Hierarchy

    Index
    candidateExpressIdsByModel? chunkSize? definedModelTagIds? limit? listConditions? modelFilterIdentity? modelTagIds? onProgress? predefinedTypeOf? signal? storeyNameOf?
    candidateExpressIdsByModel?: ReadonlyMap<string, Iterable<number, any, any>>

    Optional per-model candidate set. When supplied for a model, only those expressIds are evaluated (the typical use is "narrow with Tier-1 first, then verify structured rules"). Models absent from the map fall back to a full scan with index prefilters applied. Pass an empty iterable to skip a model entirely.

    chunkSize?: number

    Rows per yield boundary. Default 20_000.

    definedModelTagIds?: ReadonlySet<string>

    Every tag id that exists. A modelTag rule naming any other id is UNRESOLVED and matches nothing — absent means "no tags exist", so every rule naming a tag is unresolved, never silently broad.

    limit?: number

    Cap. Default 5_000 — enough for downstream batch ops, cheap to bump.

    listConditions?: ListConditionMatcher

    Answers listCondition rules for this model (#6190); see EvaluatorModel.listConditions.

    modelFilterIdentity?: string

    Stable identity used by persisted model rules; defaults to modelId.

    modelTagIds?: ReadonlySet<string>

    This model's tag ids (modelTag rules, #4215); absent = untagged.

    onProgress?: (scanned: number, total: number) => void

    Progress callback fired after each chunk: (scanned, total). When total is unknown (Tier-1 candidate iterables without .size), it's reported as -1.

    predefinedTypeOf?: (expressId: number) => string

    Optional predefined-type resolver. Falls back to "" when omitted.

    signal?: AbortSignal

    Aborts the run between chunks. Throws DOMException("…", "AbortError").

    storeyNameOf?: (expressId: number) => string

    Optional storey-name resolver. Falls back to spatial-hierarchy lookup.

    Settings
    Member Visibility

    On This Page
    Properties