Class View<PropertiesOptions, PropertiesResponse>

TODO

Type parameters

PropertiesOptions: object
PropertiesResponse: object

Hierarchy

View
- ArangoSearchView

Index

Accessors

Methods

Accessors

isArangoView

get isArangoView(): true

internal

Indicates that this object represents an ArangoDB View.

Returns true

name

get name(): string

TODO

Returns string

Methods

create

create(options?: PropertiesOptions): Promise<PropertiesResponse>

TODO

Parameters
- Optional options: PropertiesOptions
Returns Promise<PropertiesResponse>

drop

drop(): Promise<boolean>

TODO

Returns Promise<boolean>

exists

exists(): Promise<boolean>

TODO

Returns Promise<boolean>

get

get(): Promise<ViewResponse & ArangoResponseMetadata>

TODO

Returns Promise<ViewResponse & ArangoResponseMetadata>

properties

properties(): Promise<PropertiesResponse & ArangoResponseMetadata>

TODO

Returns Promise<PropertiesResponse & ArangoResponseMetadata>

rename

rename(newName: string): Promise<ViewResponse & ArangoResponseMetadata>

TODO

Parameters
- newName: string
Returns Promise<ViewResponse & ArangoResponseMetadata>

replaceProperties

replaceProperties(properties?: PropertiesOptions): Promise<PropertiesResponse>

TODO

Parameters
- Optional properties: PropertiesOptions
Returns Promise<PropertiesResponse>

updateProperties

updateProperties(properties?: PropertiesOptions): Promise<PropertiesResponse>

TODO

Parameters
- Optional properties: PropertiesOptions
Returns Promise<PropertiesResponse>

Generated using TypeDoc