Skip to content

Commit 2b0051d

Browse files
committed
Added @static doc identifiers
1 parent 1abfdda commit 2b0051d

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

lib/gridfs/grid_store.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1063,6 +1063,7 @@ GridStore.IO_SEEK_END = 2;
10631063
* Checks if a file exists in the database.
10641064
*
10651065
* @method
1066+
* @static
10661067
* @param {Db} db the database to query.
10671068
* @param {string} name The name of the file to look for.
10681069
* @param {string} [rootCollection] The root collection that holds the files and chunks collection. Defaults to **{GridStore.DEFAULT_ROOT_COLLECTION}**.
@@ -1104,6 +1105,7 @@ GridStore.exist = function(db, fileIdObject, rootCollection, options, callback)
11041105
* Gets the list of files stored in the GridFS.
11051106
*
11061107
* @method
1108+
* @static
11071109
* @param {Db} db the database to query.
11081110
* @param {string} [rootCollection] The root collection that holds the files and chunks collection. Defaults to **{GridStore.DEFAULT_ROOT_COLLECTION}**.
11091111
* @param {object} [options=null] Optional settings.
@@ -1158,6 +1160,7 @@ GridStore.list = function(db, rootCollection, options, callback) {
11581160
* (db, name, length, offset, options, callback)
11591161
*
11601162
* @method
1163+
* @static
11611164
* @param {Db} db the database to query.
11621165
* @param {string} name The name of the file.
11631166
* @param {number} [length] The size of data to read.
@@ -1197,6 +1200,7 @@ GridStore.read = function(db, name, length, offset, options, callback) {
11971200
* Read the entire file as a list of strings splitting by the provided separator.
11981201
*
11991202
* @method
1203+
* @static
12001204
* @param {Db} db the database to query.
12011205
* @param {(String|object)} name the name of the file.
12021206
* @param {string} [separator] The character to be recognized as the newline separator.
@@ -1222,6 +1226,7 @@ GridStore.readlines = function(db, name, separator, options, callback) {
12221226
* Deletes the chunks and metadata information of a file from GridFS.
12231227
*
12241228
* @method
1229+
* @static
12251230
* @param {Db} db The database to query.
12261231
* @param {(string|array)} names The name/names of the files to delete.
12271232
* @param {object} [options=null] Optional settings.

lib/mongo_client.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ function MongoClient() {
5858
* docs.mongodb.org/manual/reference/connection-string/
5959
*
6060
* @method
61+
* @static
6162
* @param {string} url The connection URI string
6263
* @param {object} [options=null] Optional settings.
6364
* @param {boolean} [options.uri_decode_auth=false] Uri decode the user name and password for authentication

0 commit comments

Comments
 (0)