breeze-client / NodeMeta

Interface: NodeMeta

Defined in: src/metadata/data-service.ts:220

What a JsonResultsAdapter's visitNode returns for one node of a query or save result, telling Breeze how to treat it. Every property is optional; returning {} (or nothing) treats the node as plain data.

Properties

entityType?

optional entityType?: EntityType

Defined in: src/metadata/data-service.ts:222

The type of entity or complex object this node is, or its name. When set, Breeze materializes the node as an entity of that type and merges it into the cache (unless the query is noTracking); a complex type is mapped without merging. For a top-level query result with no type, Breeze uses the query's result type.

---

extraMetadata?

optional extraMetadata?: any

Defined in: src/metadata/data-service.ts:232

Anything else about the node to keep. Breeze stores it on the entity's entityAspect.extraMetadata.

---

ignore?

optional ignore?: boolean

Defined in: src/metadata/data-service.ts:228

Whether to skip this node. A skipped property is left off the object that holds it; a skipped top-level node is dropped from the results (or is null there, when the query includes deleted entities).

---

node?

optional node?: any

Defined in: src/metadata/data-service.ts:234

Use this object in place of the node that was visited.

---

nodeId?

optional nodeId?: string

Defined in: src/metadata/data-service.ts:224

An id for this node, such as a Json.NET $id, that other nodes can refer to with nodeRefId.

---

nodeRefId?

optional nodeRefId?: string

Defined in: src/metadata/data-service.ts:226

The nodeId of another node that this node stands for, such as a Json.NET $ref. Breeze returns the entity or object read from that node in its place.

---

passThru?

optional passThru?: boolean

Defined in: src/metadata/data-service.ts:230

Whether to keep the node exactly as the server sent it, without mapping its property names to the client's or visiting what it contains. Ignored for a top-level node that has an entityType, which is merged as an entity.