Skip to content

Commit b2c417b

Browse files
committed
Fix dead at-links in comments
1 parent 633095a commit b2c417b

File tree

4 files changed

+22
-14
lines changed

4 files changed

+22
-14
lines changed

src/collection.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,7 @@ export type CollectionKeyOptions = {
408408
* Options for creating a collection.
409409
*
410410
* See {@link Database.createCollection}, {@link Database.createEdgeCollection}
411-
* and {@link Collection.create}.
411+
* and {@link DocumentCollection.create} or {@link EdgeCollection.create}.
412412
*/
413413
export type CreateCollectionOptions = {
414414
/**

src/database.ts

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1857,7 +1857,11 @@ export class Database {
18571857

18581858
//#region collections
18591859
/**
1860-
* Returns a {@link Collection} instance for the given collection name.
1860+
* Returns a `Collection` instance for the given collection name.
1861+
*
1862+
* In TypeScript the collection implements both the
1863+
* {@link DocumentCollection} and {@link EdgeCollection} interfaces and can
1864+
* be cast to either type to enforce a stricter API.
18611865
*
18621866
* @param T - Type to use for document data. Defaults to `any`.
18631867
* @param collectionName - Name of the edge collection.
@@ -2017,7 +2021,7 @@ export class Database {
20172021
/**
20182022
* Renames the collection `collectionName` to `newName`.
20192023
*
2020-
* Additionally removes any stored {@link Collection} instance for
2024+
* Additionally removes any stored `Collection` instance for
20212025
* `collectionName` from the `Database` instance's internal cache.
20222026
*
20232027
* **Note**: Renaming collections may not be supported when ArangoDB is
@@ -2080,7 +2084,11 @@ export class Database {
20802084

20812085
/**
20822086
* Fetches all collections from the database and returns an array of
2083-
* {@link Collection} instances.
2087+
* `Collection` instances.
2088+
*
2089+
* In TypeScript these instances implement both the
2090+
* {@link DocumentCollection} and {@link EdgeCollection} interfaces and can
2091+
* be cast to either type to enforce a stricter API.
20842092
*
20852093
* See also {@link Database.listCollections}.
20862094
*
@@ -2377,7 +2385,7 @@ export class Database {
23772385
* value.
23782386
*
23792387
* Collections can be specified as collection names (strings) or objects
2380-
* implementing the {@link ArangoCollection} interface: {@link Collection},
2388+
* implementing the {@link ArangoCollection} interface: `Collection`,
23812389
* {@link GraphVertexCollection}, {@link GraphEdgeCollection} as well as
23822390
* (in TypeScript) {@link DocumentCollection} and {@link EdgeCollection}.
23832391
*
@@ -2430,7 +2438,7 @@ export class Database {
24302438
* Performs a server-side transaction and returns its return value.
24312439
*
24322440
* Collections can be specified as collection names (strings) or objects
2433-
* implementing the {@link ArangoCollection} interface: {@link Collection},
2441+
* implementing the {@link ArangoCollection} interface: `Collection`,
24342442
* {@link GraphVertexCollection}, {@link GraphEdgeCollection} as well as
24352443
* (in TypeScript) {@link DocumentCollection} and {@link EdgeCollection}.
24362444
*
@@ -2479,7 +2487,7 @@ export class Database {
24792487
* Performs a server-side transaction and returns its return value.
24802488
*
24812489
* The Collection can be specified as a collection name (string) or an object
2482-
* implementing the {@link ArangoCollection} interface: {@link Collection},
2490+
* implementing the {@link ArangoCollection} interface: `Collection`,
24832491
* {@link GraphVertexCollection}, {@link GraphEdgeCollection} as well as
24842492
* (in TypeScript) {@link DocumentCollection} and {@link EdgeCollection}.
24852493
*
@@ -2573,7 +2581,7 @@ export class Database {
25732581
* a {@link Transaction} instance for the transaction.
25742582
*
25752583
* Collections can be specified as collection names (strings) or objects
2576-
* implementing the {@link ArangoCollection} interface: {@link Collection},
2584+
* implementing the {@link ArangoCollection} interface: `Collection`,
25772585
* {@link GraphVertexCollection}, {@link GraphEdgeCollection} as well as
25782586
* (in TypeScript) {@link DocumentCollection} and {@link EdgeCollection}.
25792587
*
@@ -2603,7 +2611,7 @@ export class Database {
26032611
* a {@link Transaction} instance for the transaction.
26042612
*
26052613
* Collections can be specified as collection names (strings) or objects
2606-
* implementing the {@link ArangoCollection} interface: {@link Collection},
2614+
* implementing the {@link ArangoCollection} interface: `Collection`,
26072615
* {@link GraphVertexCollection}, {@link GraphEdgeCollection} as well as
26082616
* (in TypeScript) {@link DocumentCollection} and {@link EdgeCollection}.
26092617
*
@@ -2634,7 +2642,7 @@ export class Database {
26342642
* a {@link Transaction} instance for the transaction.
26352643
*
26362644
* The Collection can be specified as a collection name (string) or an object
2637-
* implementing the {@link ArangoCollection} interface: {@link Collection},
2645+
* implementing the {@link ArangoCollection} interface: `Collection`,
26382646
* {@link GraphVertexCollection}, {@link GraphEdgeCollection} as well as
26392647
* (in TypeScript) {@link DocumentCollection} and {@link EdgeCollection}.
26402648
*

src/graph.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,7 @@ export type GraphCreateOptions = {
367367
};
368368

369369
/**
370-
* Represents a {@link Collection} of vertices in a {@link Graph}.
370+
* Represents a {@link DocumentCollection} of vertices in a {@link Graph}.
371371
*
372372
* @param T - Type to use for document data. Defaults to `any`.
373373
*/
@@ -774,7 +774,7 @@ export class GraphVertexCollection<T extends object = any>
774774
}
775775

776776
/**
777-
* Represents a {@link Collection} of edges in a {@link Graph}.
777+
* Represents a {@link EdgeCollection} of edges in a {@link Graph}.
778778
*
779779
* @param T - Type to use for document data. Defaults to `any`.
780780
*/

src/transaction.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,8 +172,8 @@ export class Transaction {
172172
* @param callback - Callback function returning a promise.
173173
*
174174
* **Warning**: The callback function should wrap a single call of an async
175-
* arangojs method (e.g. a method on a {@link Collection} object of a
176-
* collection that is involved in the transaction or the `db.query` method).
175+
* arangojs method (e.g. a method on a `Collection` object of a collection
176+
* that is involved in the transaction or the `db.query` method).
177177
* If the callback function is async, only the first promise-returning (or
178178
* async) method call will be executed as part of the transaction. See the
179179
* examples below for how to avoid common mistakes when using this method.

0 commit comments

Comments
 (0)