Skip to main content

Home > git-documentdb > PutResult

PutResult type#

Result of put APIs (put, update, insert, putFatDoc, updateFatDoc, and insertFatDoc)

Signature:
export declare type PutResult = PutResultJsonDoc | PutResultText | PutResultBinary;
References:

PutResultJsonDoc , PutResultText , PutResultBinary

Remarks#

  • _id: _id of a JSON document. This is a file name without extension. PutResult does not have _id if a document is not JsonDoc type.

  • name: A file name in Git. e.g.) "foo.json", "bar/baz.md"

  • fileOid: SHA-1 hash of Git object (40 characters).

  • commit: Git commit object of this put operation.