Skip to content

Commit

Permalink
style(NODE-4992): tsdoc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
W-A-James committed Jan 24, 2023
1 parent 7e6ef06 commit 2dec880
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 7 deletions.
3 changes: 2 additions & 1 deletion src/db.ts
Original file line number Diff line number Diff line change
Expand Up @@ -774,7 +774,8 @@ export class Db {
return new ChangeStream<TSchema, TChange>(this, pipeline, resolveOptions(this, options));
}

/** Return the db logger
/**
* Return the db logger
* @deprecated The Legacy Logger is deprecated and will be removed in the next major version.
*/
getLogger(): Logger {
Expand Down
16 changes: 10 additions & 6 deletions src/mongo_client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -233,11 +233,13 @@ export interface MongoClientOptions extends BSONSerializeOptions, SupportedNodeC
* @deprecated Setting a custom promise library is deprecated the next major version will use the global Promise constructor only.
*/
promiseLibrary?: any;
/** The logging level
/**
* The logging level
* @deprecated The Legacy Logger is deprecated and will be removed in the next major version.
* */
*/
loggerLevel?: LegacyLoggerLevel;
/** Custom logger object
/**
* Custom logger object
* @deprecated The Legacy Logger is deprecated and will be removed in the next major version.
*/
logger?: LegacyLogger;
Expand Down Expand Up @@ -425,7 +427,7 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> {
return this.s.bsonOptions;
}

/** @deprecated The Legacy Logger is deprecated and will be removed in the next major version.*/
/** @deprecated The Legacy Logger is deprecated and will be removed in the next major version. */
get logger(): LegacyLogger {
return this.s.logger;
}
Expand Down Expand Up @@ -716,8 +718,10 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> {
return new ChangeStream<TSchema, TChange>(this, pipeline, resolveOptions(this, options));
}

/** Return the mongo client logger
* @deprecated The Legacy Logger is deprecated and will be removed in the next major version.*/
/**
* Return the mongo client logger
* @deprecated The Legacy Logger is deprecated and will be removed in the next major version.
*/
getLogger(): LegacyLogger {
return this.s.logger;
}
Expand Down

0 comments on commit 2dec880

Please sign in to comment.