Skip to main content

Home > git-documentdb > GitDocumentDB > delete

GitDocumentDB.delete() method#

Delete a JSON document

Signature:
delete(_id: string, options?: DeleteOptions): Promise<DeleteResultJsonDoc>;

Parameters#

ParameterTypeDescription
_idstring_id is a file path whose extension is omitted.
optionsDeleteOptions
Returns:

Promise<DeleteResultJsonDoc >

Remarks#

  • This is an alias of GitDocumentDB#rootCollection.delete()

Exceptions#

Err.UndefinedDocumentIdError

Err.DatabaseClosingError

Err.TaskCancelError

# Errors from deleteWorker