Collection.updateFatDoc() method

Collection.updateFatDoc() method#

Update a data

Signature:

updateFatDoc(shortName: string | undefined | null, doc: JsonDoc | string | Uint8Array, options?: PutOptions): Promise<PutResult>;

Parameter	Type	Description
shortName	string \| undefined \| null	shortName is a file path whose collectionPath is omitted. shortName of JsonDoc must ends with extension.
doc	JsonDoc \| string \| Uint8Array
options	PutOptions

Returns:

Promise<PutResult >

Throws DocumentNotFoundError if a specified data does not exist. It might be better to use put() instead of update().
The saved file path is ${GitDocumentDB#workingDir}/${Collection#collectionPath}/${shortName}${extension} .
_id property of a JsonDoc is automatically set or overwritten by shortName parameter whose extension is omitted.
An update operation is not skipped even if no change occurred on a specified data.

# Errors from validateDocument, validateId

# Errors from putWorker