breeze-client / JsonResultsAdapterConfig

Interface: JsonResultsAdapterConfig

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

Configuration info to be passed to the JsonResultsAdapter constructor

Properties

extractDeletedKeys?

optional extractDeletedKeys?: (data) => any[]

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

A function that is called once per save operation to extract any deleted keys from any json received over the wire. Must return an array. This method has a default implementation which simply returns an empty array.

Parameters

data

Returns

any[]

---

extractKeyMappings?

optional extractKeyMappings?: (data) => KeyMapping[]

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

A function that is called once per save operation to extract the key mappings from any json received over the wire. Must return an array. This method has a default implementation which simply returns the "keyMappings" property from any json returned as a result of executing the save.

Parameters

data

Returns

KeyMapping[]

---

extractResults?

optional extractResults?: Function

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

A Function that is called once per query operation to extract the 'payload' from any json received over the wire. This method has a default implementation which to simply return the "results" property from any json returned as a result of executing the query.

---

extractSaveResults?

optional extractSaveResults?: Function

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

A function that is called once per save operation to extract the entities from any json received over the wire. Must return an array. This method has a default implementation which simply returns the "entities" property from any json returned as a result of executing the save.

---

name

name: string

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

The name of this adapter. This name is used to uniquely identify and locate this instance when an 'exported' JsonResultsAdapter is later imported.

---

visitNode

visitNode: (node, mappingContext, nodeContext) => void | NodeMeta | null

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

A visitor method that will be called on each node of the returned payload. Required. Breeze always passes all three arguments. Returning nothing is the same as returning {}.

Parameters

node

any

mappingContext

MappingContext

nodeContext

NodeContext

Returns

void | NodeMeta | null