Type representing a document stored in a collection.
Type representing an object that can be stored in a collection.
Common ArangoDB metadata properties of a document.
Unique ID of the document, which is composed of the collection name
and the document _key.
Key of the document, which uniquely identifies the document within its collection.
Revision of the document data.
A value that can be used to identify a document within a collection in
arangojs methods, i.e. a partial ArangoDB document or the value of a
document's _key or _id.
See DocumentMetadata.
Type representing an edge document stored in an edge collection.
Type representing an object that can be stored in an edge collection.
ArangoDB metadata defining the relations of an edge document.
Unique ID of the document that acts as the edge's start vertex.
Unique ID of the document that acts as the edge's end vertex.
An object with an ArangoDB document _id property.
See DocumentMetadata.
An object with an ArangoDB document _key property.
See DocumentMetadata.
Type representing patch data for a given object type to represent a payload ArangoDB can apply in a document PATCH request (i.e. a partial update).
This differs from Partial in that it also applies itself to any nested
objects recursively.
Generated using TypeDoc
import type { Document, Edge } from "arangojs/document";The "document" module provides document/edge related types for TypeScript.