Skip to content

Commit 61c5495

Browse files
committed
style(NODE-4992): tsdoc fixes
1 parent f290d00 commit 61c5495

File tree

3 files changed

+17
-10
lines changed

3 files changed

+17
-10
lines changed

src/db.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -775,12 +775,13 @@ export class Db {
775775
}
776776

777777
/** Return the db logger
778-
* @deprecated The Legacy Logger is deprecated and will be removed in the next major version.*/
778+
* @deprecated The Legacy Logger is deprecated and will be removed in the next major version.
779+
*/
779780
getLogger(): Logger {
780781
return this.s.logger;
781782
}
782783

783-
/** @deprecated The Legacy Logger is deprecated and will be removed in the next major version.*/
784+
/** @deprecated The Legacy Logger is deprecated and will be removed in the next major version. */
784785
get logger(): Logger {
785786
return this.s.logger;
786787
}

src/gridfs/index.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,9 @@ export class GridFSBucket extends TypedEventEmitter<GridFSBucketEvents> {
226226
}, callback);
227227
}
228228

229-
/** Get the Db scoped logger.
229+
/**
230+
* Get the Db scoped logger.
231+
*
230232
* @deprecated Legacy Logger is deprecated and will be removed in the next major version.
231233
*/
232234
getLogger(): Logger {

src/logger.ts

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ const pid = process.pid;
1515
// eslint-disable-next-line no-console
1616
let currentLogger: LoggerFunction = console.warn;
1717

18-
/** @public
18+
/**
19+
* @public
1920
* @deprecated The Legacy Logger is deprecated and will be removed in the next major version.*/
2021
export const LoggerLevel = Object.freeze({
2122
ERROR: 'error',
@@ -28,18 +29,21 @@ export const LoggerLevel = Object.freeze({
2829
debug: 'debug'
2930
} as const);
3031

31-
/** @public
32-
* @deprecated The Legacy Logger is deprecated and will be removed in the next major version.
32+
/**
33+
* @public
34+
* @deprecated The Legacy Logger is deprecated and will be removed in the next major version.
3335
*/
3436
export type LoggerLevel = typeof LoggerLevel[keyof typeof LoggerLevel];
3537

36-
/** @public
37-
* @deprecated The Legacy Logger is deprecated and will be removed in the next major version.
38+
/**
39+
* @public
40+
* @deprecated The Legacy Logger is deprecated and will be removed in the next major version.
3841
*/
3942
export type LoggerFunction = (message?: any, ...optionalParams: any[]) => void;
4043

41-
/** @public
42-
* @deprecated The Legacy Logger is deprecated and will be removed in the next major version.
44+
/**
45+
* @public
46+
* @deprecated The Legacy Logger is deprecated and will be removed in the next major version.
4347
*/
4448
export interface LoggerOptions {
4549
logger?: LoggerFunction;

0 commit comments

Comments
 (0)