Skip to content

Commit 875fcf9

Browse files
authored
Update src/lib/GClient.ts
1 parent 9f09ea3 commit 875fcf9

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

Diff for: src/lib/GClient.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -135,8 +135,9 @@ export class GClient<Ready extends boolean = boolean> extends Client<Ready> {
135135
}
136136

137137
/**
138-
* The method that returns original types from {@link GClientOptions.database}
139-
* @param {any} _ Prototype of your class to get types.
138+
/**
139+
* The method that returns the database option provided in {@link GClientOptions}
140+
* @param {any} _ Used for typings
140141
* @returns {Database}
141142
* @example TypeScript example
142143
* ```typescript
@@ -148,7 +149,7 @@ export class GClient<Ready extends boolean = boolean> extends Client<Ready> {
148149
* })
149150
*
150151
* const db = client.getDatabase(MongoDBProvider.prototype);
151-
* // Types working in `db`
152+
* // returns <MongoDBProvider>
152153
* ```
153154
* @example JavaScript example
154155
* ```javascript
@@ -160,10 +161,9 @@ export class GClient<Ready extends boolean = boolean> extends Client<Ready> {
160161
* })
161162
*
162163
* const db = client.getDatabase(MongoDBProvider.prototype);
163-
* // Types working in `db`
164+
* // returns <MongoDBProvider>
164165
* ```
165166
*/
166-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
167167
public getDatabase<Database>(_?: Database): Database {
168168
return this.options.database;
169169
}

0 commit comments

Comments
 (0)