Skip to content

Commit ffbc0ca

Browse files
committed
style: fix tsdoc "@return" -> "@returns"
1 parent 7260add commit ffbc0ca

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ export class MongoMemoryReplSet extends EventEmitter implements ManagerAdvanced
303303
* @param otherDb add an database into the uri (in mongodb its the auth database, in mongoose its the default database for models)
304304
* @throws if state is not "running"
305305
* @throws if an server doesnt have "instanceInfo.port" defined
306-
* @return an valid mongo URI, by the definition of https://docs.mongodb.com/manual/reference/connection-string/
306+
* @returns an valid mongo URI, by the definition of https://docs.mongodb.com/manual/reference/connection-string/
307307
*/
308308
getUri(otherDb?: string): string {
309309
log('getUri:', this.state);

packages/mongodb-memory-server-core/src/MongoMemoryServer.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -648,7 +648,7 @@ export class MongoMemoryServer extends EventEmitter implements ManagerAdvanced {
648648
/**
649649
* Generate the Connection string used by mongodb
650650
* @param otherDb add an database into the uri (in mongodb its the auth database, in mongoose its the default database for models)
651-
* @return an valid mongo URI, by the definition of https://docs.mongodb.com/manual/reference/connection-string/
651+
* @returns an valid mongo URI, by the definition of https://docs.mongodb.com/manual/reference/connection-string/
652652
*/
653653
getUri(otherDb?: string): string {
654654
this.debug('getUri:', this.state);

packages/mongodb-memory-server-core/src/util/DryMongoBinary.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ export class DryMongoBinary {
122122

123123
/**
124124
* Get the full path with filename
125-
* @return Absoulte Path with FileName
125+
* @returns Absoulte Path with FileName
126126
*/
127127
static getBinaryName(opts: DryMongoBinaryNameOptions): string {
128128
log('getBinaryName');
@@ -144,7 +144,7 @@ export class DryMongoBinary {
144144
/**
145145
* Probe if the provided "systemBinary" is an existing path
146146
* @param systemBinary The Path to probe for an System-Binary
147-
* @return System Binary path or undefined
147+
* @returns System Binary path or undefined
148148
*/
149149
static async getSystemPath(systemBinary: string): Promise<string | undefined> {
150150
// REFACTOR: change this function to always return "string"
@@ -170,7 +170,7 @@ export class DryMongoBinary {
170170
* Generate an "MongoBinaryPaths" object
171171
*
172172
* This Function should not hit the FileSystem
173-
* @return an finished "MongoBinaryPaths" object
173+
* @returns an finished "MongoBinaryPaths" object
174174
*/
175175
static async generatePaths(
176176
opts: DryMongoBinaryOptions & DryMongoBinaryNameOptions
@@ -226,7 +226,7 @@ export class DryMongoBinary {
226226

227227
/**
228228
* Generate the Path where an Binary will be located
229-
* @return "boolean" indicating if the binary exists at the provided path, and "string" the path to use for the binary
229+
* @returns "boolean" indicating if the binary exists at the provided path, and "string" the path to use for the binary
230230
*/
231231
static async generateDownloadPath(
232232
opts: DryMongoBinaryOptions & DryMongoBinaryNameOptions

packages/mongodb-memory-server-core/src/util/MongoBinary.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ export class MongoBinary {
7070
* Probe all supported paths for an binary and return the binary path
7171
* @param opts Options configuring which binary to search for
7272
* @throws {Error} if no valid BinaryPath has been found
73-
* @return The first found BinaryPath
73+
* @returns The first found BinaryPath
7474
*/
7575
static async getPath(opts: MongoBinaryOpts = {}): Promise<string> {
7676
log('getPath');

packages/mongodb-memory-server-core/src/util/MongoBinaryDownload.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ export class MongoBinaryDownload {
111111

112112
/**
113113
* Get the full path with filename
114-
* @return Absoulte Path with FileName
114+
* @returns Absoulte Path with FileName
115115
*/
116116
protected async getPath(): Promise<string> {
117117
const opts = await DryMongoBinary.generateOptions(this.binaryOpts);
@@ -213,7 +213,7 @@ export class MongoBinaryDownload {
213213
/**
214214
* Download file from downloadUrl
215215
* @param downloadUrl URL to download a File
216-
* @return The Path to the downloaded archive file
216+
* @returns The Path to the downloaded archive file
217217
*/
218218
async download(downloadUrl: string): Promise<string> {
219219
log('download');

0 commit comments

Comments
 (0)