Type alias CollectionReadOptions

CollectionReadOptions: { allowDirtyRead?: boolean; graceful?: boolean; ifMatch?: string; ifNoneMatch?: string }

Options for retrieving a document from a collection.

Type declaration

  • Optional allowDirtyRead?: boolean

    If set to true, the request will explicitly permit ArangoDB to return a potentially dirty or stale result and arangojs will load balance the request without distinguishing between leaders and followers.

  • Optional graceful?: boolean

    If set to true, null is returned instead of an exception being thrown if the document does not exist.

  • Optional ifMatch?: string

    If set to a document revision, the request will fail with an error if the document exists but its _rev does not match the given revision.

  • Optional ifNoneMatch?: string

    If set to a document revision, the request will fail with an error if the document exists and its _rev matches the given revision. Note that an HttpError with code 304 will be thrown instead of an ArangoError.

Generated using TypeDoc