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<DocumentMetadata & { old?: Document<T> }>

TODO

Parameters
- selector: DocumentSelector
- Optional options: GraphCollectionRemoveOptions
Returns Promise<DocumentMetadata & { old?: Document<T> }>

replace

replace(selector: DocumentSelector, newValue: DocumentData<T>, options?: GraphCollectionReplaceOptions): Promise<DocumentMetadata & { new?: Document<T>; old?: Document<T> }>

TODO

Parameters
- selector: DocumentSelector
- newValue: DocumentData<T>
- Optional options: GraphCollectionReplaceOptions
Returns Promise<DocumentMetadata & { new?: Document<T>; old?: Document<T> }>

save

save(data: EdgeData<T>, options?: GraphCollectionInsertOptions): Promise<DocumentMetadata & { new?: Document<T> }>

TODO

Parameters
- data: EdgeData<T>
- Optional options: GraphCollectionInsertOptions
Returns Promise<DocumentMetadata & { new?: Document<T> }>

update

update(selector: DocumentSelector, newValue: Patch<DocumentData<T>>, options?: GraphCollectionReplaceOptions): Promise<DocumentMetadata & { new?: Document<T>; old?: Document<T> }>

TODO

Parameters
- selector: DocumentSelector
- newValue: Patch<DocumentData<T>>
- Optional options: GraphCollectionReplaceOptions
Returns Promise<DocumentMetadata & { new?: Document<T>; old?: Document<T> }>

vertex

vertex(selector: DocumentSelector, options?: GraphCollectionReadOptions): Promise<Document<T>>
vertex(selector: DocumentSelector, graceful: boolean): Promise<Document<T>>

TODO

Parameters
- selector: DocumentSelector
- Optional options: GraphCollectionReadOptions
Returns Promise<Document<T>>
TODO

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

vertexExists

vertexExists(selector: DocumentSelector): Promise<boolean>

TODO

Parameters
- selector: DocumentSelector
Returns Promise<boolean>

Generated using TypeDoc