firecms/website/docs/api/functions/saveentity.md

id, title, sidebar_label, sidebar_position, custom_edit_url

id	title	sidebar_label	sidebar_position	custom_edit_url
saveentity	Function: saveEntity	saveEntity	0	null

▸ saveEntity<S, Key>(__namedParameters): Promise<void>

Save entity to the specified path. Note that Firestore does not allow undefined values.

Type parameters

Name	Type
S	S: EntitySchema<Key, any, S>
Key	Key: string = Extract<keyof S["properties"], string>

Parameters

Name	Type
__namedParameters	Object
__namedParameters.collectionPath	string
__namedParameters.context	CMSAppContext
__namedParameters.id	string | undefined
__namedParameters.onPreSaveHookError?	(e: Error) => void
__namedParameters.onSaveFailure?	(e: Error) => void
__namedParameters.onSaveSuccess?	(entity: Entity<S, Key>) => void
__namedParameters.onSaveSuccessHookError?	(e: Error) => void
__namedParameters.schema	S
__namedParameters.status	EntityStatus
__namedParameters.values	Partial<EntityValues<S, Key>>

Returns

Promise<void>

Defined in

models/firestore.ts:233