Member Junction
    Preparing search index...

    Interface CachedEntityMatch<T>

    One loaded engine's in-memory cache of a given entity, returned by BaseEngineRegistry.FindCachedEntity. Carries enough context to both use the cache (a live pointer to the array) and vet it (the config that produced it, and whether it's the full unfiltered entity set).

    interface CachedEntityMatch<T extends BaseEntity = BaseEntity> {
        config: BaseEnginePropertyConfig;
        engine: unknown;
        engineClassName: string;
        records: T[];
        unfiltered: boolean;
    }

    Type Parameters

    Index

    Properties

    The engine's full property config for this entity — EntityName, PropertyName, Filter, OrderBy, ResultType, etc. Inspect this to decide whether the cache fits your needs (e.g. check Filter/ResultType).

    engine: unknown

    The live engine instance (a BaseEngine singleton).

    engineClassName: string

    Class name of the engine that holds this cache (e.g. 'UserInfoEngine').

    records: T[]

    Live reference to the engine's cached array for this entity — NOT a copy. Reading is cheap; do not mutate it. When the config's ResultType is 'simple' these are plain objects rather than BaseEntity instances.

    unfiltered: boolean

    True when the config has no Filter — i.e. the cache holds the entire entity set and can be treated as authoritative (safe for "show all" / in-memory search). False when a Filter means it's only a subset.