IFClite TypeScript API
    Preparing search index...

    Interface EffectiveEntityOverlay

    The overlay half of a live session, as enumeration needs it.

    interface EffectiveEntityOverlay {
        getNewEntities(): readonly { expressId: number; type: string }[];
        getNewEntitiesOfType?(
            type: string,
        ): Iterable<{ expressId: number; type: string }>;
        getNewEntity?(expressId: number): { type: string } | null;
        getTombstones?(): ReadonlySet<number>;
        getTypeMutations?(): ReadonlyMap<number, { newType: string }>;
        isDeleted(expressId: number): boolean;
    }

    Hierarchy (View Summary)

    Index
    getNewEntities getNewEntitiesOfType? getNewEntity? getTombstones? getTypeMutations? isDeleted

    • Overlay-created entities, in creation order, with their authored class.

      Returns readonly { expressId: number; type: string }[]

    • Created entities authored as one class, in creation order. Lets a single-class query skip the other created entities, which is what keeps per-element authoring linear (#5413). Absent: the full list is scanned.

      Parameters

      • type: string

      Returns Iterable<{ expressId: number; type: string }>

    • O(1) created-entity lookup. Absent (a plain-data snapshot): membership is built from getNewEntities.

      Parameters

      • expressId: number

      Returns { type: string } | null

    • Optional indexed tombstones let aggregate counts avoid a full source walk.

      Returns ReadonlySet<number>

    • Retype intents by express id. Absent means the overlay carries none.

      Returns ReadonlyMap<number, { newType: string }>

    • True for a deleted source entity and for a created-then-deleted one.

      Parameters

      • expressId: number

      Returns boolean

    Settings
    Member Visibility

    On This Page
    Methods