Class GraphVertexCollection<T>

TODO

Type parameters

T: object

Hierarchy

GraphVertexCollection

Implements

ArangoCollection

Index

Accessors

Methods

Accessors

collection

get collection(): DocumentCollection<T>

TODO

Returns DocumentCollection<T>

graph

get graph(): Graph

TODO

Returns Graph

isArangoCollection

get isArangoCollection(): true

internal

Indicates that this object represents an ArangoDB collection.

Returns true

name

get name(): string

TODO

Returns string

Methods

remove

remove(selector: DocumentSelector, options?: GraphCollectionRemoveOptions): Promise<CollectionRemoveResult<Document<T>>>

TODO

Parameters
- selector: DocumentSelector
- Default value options: GraphCollectionRemoveOptions = {}
Returns Promise<CollectionRemoveResult<Document<T>>>

replace

replace(selector: DocumentSelector, newValue: DocumentData<T>, options?: GraphCollectionReplaceOptions): Promise<CollectionSaveResult<Document<T>>>

TODO

Parameters
- selector: DocumentSelector
- newValue: DocumentData<T>
- Default value options: GraphCollectionReplaceOptions = {}
Returns Promise<CollectionSaveResult<Document<T>>>

save

save(data: DocumentData<T>, options?: GraphCollectionInsertOptions): Promise<CollectionInsertResult<Document<T>>>

TODO

Parameters
- data: DocumentData<T>
- Optional options: GraphCollectionInsertOptions
Returns Promise<CollectionInsertResult<Document<T>>>

update

update(selector: DocumentSelector, newValue: Patch<DocumentData<T>>, options?: GraphCollectionReplaceOptions): Promise<CollectionSaveResult<Document<T>>>

TODO

Parameters
- selector: DocumentSelector
- newValue: Patch<DocumentData<T>>
- Default value options: GraphCollectionReplaceOptions = {}
Returns Promise<CollectionSaveResult<Document<T>>>

vertex

vertex(selector: DocumentSelector, options?: GraphCollectionReadOptions & { graceful?: undefined | false }): Promise<Document<T>>
vertex(selector: DocumentSelector, options: GraphCollectionReadOptions & { graceful: true }): Promise<Document<T> | null>
vertex(selector: DocumentSelector, graceful: false): Promise<Document<T>>
vertex(selector: DocumentSelector, graceful: true): Promise<Document<T> | null>

TODO

Parameters
- selector: DocumentSelector
- Optional options: GraphCollectionReadOptions & { graceful?: undefined | false }
Returns Promise<Document<T>>
TODO

Parameters
- selector: DocumentSelector
- options: GraphCollectionReadOptions & { graceful: true }
Returns Promise<Document<T> | null>
TODO

Parameters
- selector: DocumentSelector
- graceful: false
Returns Promise<Document<T>>
TODO

Parameters
- selector: DocumentSelector
- graceful: true
Returns Promise<Document<T> | null>

vertexExists

vertexExists(selector: DocumentSelector): Promise<boolean>

TODO

Parameters
- selector: DocumentSelector
Returns Promise<boolean>

Generated using TypeDoc