Skip to content

Tightened up types on graph collection operations #625

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 24, 2019
Merged

Tightened up types on graph collection operations #625

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 33 additions & 12 deletions src/graph.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,27 @@ import {
import { Connection } from "./connection";
import { isArangoError } from "./error";

export interface InsertOptions {
waitForSync?: boolean;
returnNew?: boolean;
}

export interface ReplaceOptions extends InsertOptions {
waitForSync?: boolean;
keepNull?: boolean;
returnOld?: boolean;
returnNew?: boolean;
rev?: string;
}

export interface RemoveOptions {
waitForSync?: boolean;
returnOld?: boolean;
rev?: string;
}

export interface UpdateOptions extends ReplaceOptions {}

export class GraphVertexCollection extends BaseCollection {
type = CollectionType.DOCUMENT_COLLECTION;

Expand Down Expand Up @@ -67,7 +88,7 @@ export class GraphVertexCollection extends BaseCollection {
return this.document(documentHandle, opts);
}

save(data: Object | Array<Object>, opts?: { waitForSync?: boolean }) {
save(data: Object | Array<Object>, opts?: InsertOptions) {
return this._connection.request(
{
method: "POST",
Expand All @@ -82,7 +103,7 @@ export class GraphVertexCollection extends BaseCollection {
replace(
documentHandle: DocumentHandle,
newValue: Object | Array<Object>,
opts: any = {}
opts: ReplaceOptions | string = {}
) {
const headers: { [key: string]: string } = {};
if (typeof opts === "string") {
Expand Down Expand Up @@ -110,7 +131,7 @@ export class GraphVertexCollection extends BaseCollection {
update(
documentHandle: DocumentHandle,
newValue: Object | Array<Object>,
opts: any = {}
opts: UpdateOptions | string = {}
) {
const headers: { [key: string]: string } = {};
if (typeof opts === "string") {
Expand All @@ -135,7 +156,7 @@ export class GraphVertexCollection extends BaseCollection {
);
}

remove(documentHandle: DocumentHandle, opts: any = {}) {
remove(documentHandle: DocumentHandle, opts: RemoveOptions | string = {}) {
const headers: { [key: string]: string } = {};
if (typeof opts === "string") {
opts = { rev: opts };
Expand Down Expand Up @@ -203,19 +224,19 @@ export class GraphEdgeCollection extends EdgeCollection {

save(
data: Object | Array<Object>,
opts?: { waitForSync?: boolean }
opts?: InsertOptions
): Promise<any>;
save(
data: Object | Array<Object>,
fromId: DocumentHandle,
toId: DocumentHandle,
opts?: { waitForSync?: boolean }
opts?: InsertOptions
): Promise<any>;
save(
data: Object | Array<Object>,
fromIdOrOpts?: DocumentHandle | { waitForSync?: boolean },
fromIdOrOpts?: DocumentHandle | InsertOptions,
toId?: DocumentHandle,
opts?: { waitForSync?: boolean }
opts?: InsertOptions
) {
if (toId !== undefined) {
const fromId = this._documentHandle(fromIdOrOpts as DocumentHandle);
Expand All @@ -227,7 +248,7 @@ export class GraphEdgeCollection extends EdgeCollection {
}
} else {
if (fromIdOrOpts !== undefined) {
opts = fromIdOrOpts as { waitForSync?: boolean };
opts = fromIdOrOpts as InsertOptions;
}
}
return this._connection.request(
Expand All @@ -244,7 +265,7 @@ export class GraphEdgeCollection extends EdgeCollection {
replace(
documentHandle: DocumentHandle,
newValue: Object | Array<Object>,
opts: any = {}
opts: ReplaceOptions | string = {}
) {
const headers: { [key: string]: string } = {};
if (typeof opts === "string") {
Expand Down Expand Up @@ -272,7 +293,7 @@ export class GraphEdgeCollection extends EdgeCollection {
update(
documentHandle: DocumentHandle,
newValue: Object | Array<Object>,
opts: any = {}
opts: UpdateOptions | string = {}
) {
const headers: { [key: string]: string } = {};
if (typeof opts === "string") {
Expand All @@ -297,7 +318,7 @@ export class GraphEdgeCollection extends EdgeCollection {
);
}

remove(documentHandle: DocumentHandle, opts: any = {}) {
remove(documentHandle: DocumentHandle, opts: RemoveOptions | string = {}) {
const headers: { [key: string]: string } = {};
if (typeof opts === "string") {
opts = { rev: opts };
Expand Down