Skip to content

breeze-client / EntityByKeyResult

Interface: EntityByKeyResult<T> ​

Defined in: src/manager/entity-manager.ts:2202

IEntityByKeyResult for a known entity type - what the constructor overload of EntityManager.fetchEntityByKey returns.

Extends ​

Type Parameters ​

T ​

T extends Entity

Properties ​

entity ​

entity: T | null

Defined in: src/manager/entity-manager.ts:2203

The entity, or null if there is none.

null rather than undefined, because that is what absence means everywhere else in Breeze: a scalar navigation property with nothing cached is null, a nullable data property is null, and EntityManager.getEntityByKey returns null. Before 3.0 this one property was the exception. See UPGRADE.md.

Overrides ​

IEntityByKeyResult.entity


entityKey ​

entityKey: EntityKey

Defined in: src/manager/entity-manager.ts:2192

The key that was looked up.

Inherited from ​

IEntityByKeyResult.entityKey


fromCache ​

fromCache: boolean

Defined in: src/manager/entity-manager.ts:2197

True if the answer came from the local cache, which is only checked when checkLocalCacheFirst is true; false if the server was queried. It can be true with a null entity: the cached entity is Deleted, and the manager's queryOptions exclude deleted entities and do not use MergeStrategy.OverwriteChanges.

Inherited from ​

IEntityByKeyResult.fromCache

Released under the MIT License.