Skip to content

breeze-client / ImportConfig

Interface: ImportConfig ​

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

Configuration info to be passed to the EntityManager.importEntities method

Properties ​

mergeAdds? ​

optional mergeAdds?: boolean

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

If true, merge Added entities (with temp keys) as well. This can be dangerous.


mergeStrategy? ​

optional mergeStrategy?: MergeStrategy

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

How to merge an imported entity into one with the same key already in this manager. Defaults to the manager's queryOptions.mergeStrategy. With MergeStrategy.Disallowed the import throws on such an entity. Added entities with temporary keys are never merged unless mergeAdds is set.


metadataVersionFn? ​

optional metadataVersionFn?: (arg) => void

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

Called before anything is imported when the bundle was exported without metadata, with the MetadataStore.metadataVersion of the Breeze that exported it and the name of the exporting manager's MetadataStore. Throw from it to stop the import if the bundle does not match this manager's metadata. Not called when the bundle includes metadata.

Parameters ​

arg ​
metadataStoreName ​

any

metadataVersion ​

any

Returns ​

void

Released under the MIT License.