Skip to content

Modify typescript d.ts #447

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

Closed
wants to merge 2 commits into from
Closed

Modify typescript d.ts #447

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
57c54ea
aa
greenkeeperio-bot Apr 27, 2017
6b88031
Merge pull request #1 from xygahs0801/mmmmm_master
xygahs0801 May 4, 2017
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
39 changes: 23 additions & 16 deletions arangojs.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,21 @@
declare module "arangojs" {

export class Database {
constructor (config?: any);
interface A {
url: string;
databaseName: string | boolean;
}
function arangojs(config: A | string): Database;
export = arangojs;
class Database {
constructor(config?: any);
/**
* Updates the Database instance and its connection string to use
* the given `databaseName`, then returns itself.
*
* @param databaseName The name of the database to use.
*/
useDatabase(databaseName: string): any;
useBasicAuth(username: string, password: string): void;
useBearerAuth(token: string);
/**
* Creates a new database with the the given `databaseName`
*
Expand Down Expand Up @@ -79,7 +86,7 @@ declare module "arangojs" {
graphs(): Promise<Graph[]>;
/**
* Performs a server-side transaction and returns its return value.
*
*
* If `collections` is an array or string, it will be treated as `collections.write`.
*
* @param collections An object with arrays of names (or single name) of collections that will be read/written during the transaction.
Expand Down Expand Up @@ -132,7 +139,7 @@ declare module "arangojs" {
route(path?: string, headers?: any): Promise<Route>;
}

export class Collection {
class Collection {
/**
* Retrieves general information about the collection
*/
Expand Down Expand Up @@ -351,7 +358,7 @@ declare module "arangojs" {
list(type?: string): Promise<string[]>;
}

export class DocumentCollection extends Collection {
class DocumentCollection extends Collection {
/**
* Retrieves the document with the given documentHandle from the collection
* @param documentHandle The handle of the document to retrieve. This can be either the `_id` or the `_key` of a document in the collection, or a document (i.e. an object with an `_id` or `_key` property)
Expand All @@ -364,7 +371,7 @@ declare module "arangojs" {
save(data: any, opts?: any): Promise<any>;
}

export class EdgeCollection extends Collection {
class EdgeCollection extends Collection {
/**
* Retrieves the edge with the given documentHandle from the collection
*
Expand Down Expand Up @@ -406,7 +413,7 @@ declare module "arangojs" {
traversal(startVertex: string, opts: any): any;
}

export class Cursor {
class Cursor {
/**
* The total number of documents in the query result. This is only available if the count option was used
*/
Expand Down Expand Up @@ -464,7 +471,7 @@ declare module "arangojs" {
reduce(callback: (value: any, index: number, cursor: Cursor) => any, accu?: any): Promise<any>;
}

export class Route {
class Route {
/**
* Returns a new Route instance for the given path (relative to the current route) that can be used to perform arbitrary HTTP requests
*
Expand Down Expand Up @@ -525,7 +532,7 @@ declare module "arangojs" {
request(opts?: any): Promise<any>;
}

export class Graph {
class Graph {
/**
* Retrieves general information about the graph
*/
Expand Down Expand Up @@ -596,7 +603,7 @@ declare module "arangojs" {
traversal(startVertex: string, opts: any): Promise<any>;
}

export class GraphVertexCollection extends Collection {
class GraphVertexCollection extends Collection {
/**
* Deletes the vertex with the given documentHandle from the collection.
* @param documentHandle The handle of the vertex to retrieve. This can be either the _id or the _key of a vertex in the collection, or a vertex (i.e.an object with an _id or _key property).
Expand All @@ -614,7 +621,7 @@ declare module "arangojs" {
save(data: any): Promise<any>;
}

export class GraphEdgeCollection extends Collection {
class GraphEdgeCollection extends Collection {
/**
* Deletes the edge with the given documentHandle from the collection.
* @param documentHandle The handle of the vertex to retrieve. This can be either the _id or the _key of a vertex in the collection, or a vertex (i.e.an object with an _id or _key property).
Expand All @@ -634,16 +641,16 @@ declare module "arangojs" {
save(data: any, fromId?: string, toId?: string): Promise<any>;
/**
* Retrieves a list of all edges of the document with the given documentHandle.
* @param documentHandle The handle of the document to retrieve the edges of. This can be either the _id of a document in the database, the _key of an edge in the collection, or a document (i.e. an
* @param documentHandle The handle of the document to retrieve the edges of. This can be either the _id of a document in the database, the _key of an edge in the collection, or a document (i.e. an

with an _id or _key property).
*/
edges(documentHandle: string): Promise< Array<any> >;
edges(documentHandle: string): Promise<Array<any>>;
/**
* Retrieves a list of all incoming edges of the document with the given documentHandle.
* @param documentHandle The handle of the document to retrieve the edges of. This can be either the _id of a document in the database, the _key of an edge in the collection, or a document (i.e. an object with an _id or _key property).
*/
inEdges(documentHandle: string): Promise< Array<any> >;
inEdges(documentHandle: string): Promise<Array<any>>;
/**
* Retrieves a list of all outgoing edges of the document with the given documentHandle.
* @param documentHandle The handle of the document to retrieve the edges of. This can be either the _id of a document in the database, the _key of an edge in the collection, or a document (i.e. an object with an _id or _key property).
Expand Down