chore: jsdoc improvements

smtp/address.ts

@@ -31,7 +31,7 @@ const OPERATORS = new Map([
 /**
  * Tokenizes the original input string
  *
- * @param {string | string[] | undefined} address string(s) to tokenize
+ * @param {string | string[]} [address=''] string(s) to tokenize
  * @return {AddressToken[]} An array of operator & text tokens
  */
 function tokenizeAddress(address: string | string[] = '') {
@@ -208,7 +208,7 @@ function convertAddressTokens(tokens: AddressToken[]) {
  *
  *     [{name: "Name", address: "address@domain"}]
  *
- * @param {string | string[] | undefined} address
+ * @param {string | string[] | undefined} [address]
  * @return {AddressObject[]}
  */
 export function addressparser(address?: string | string[]) {

smtp/client.ts

@@ -35,7 +35,7 @@ export class SMTPClient {
 	 *
 	 * NOTE: `host` is trimmed before being used to establish a connection; however, the original untrimmed value will still be visible in configuration.
 	 *
-	 * @param {SMTPConnectionOptions} server smtp options
+	 * @param {Partial<SMTPConnectionOptions>} server smtp options
 	 */
 	constructor(server: Partial<SMTPConnectionOptions>) {
 		this.smtp = new SMTPConnection(server);
@@ -223,7 +223,7 @@ export class SMTPClient {
 
 	/**
 	 * @protected
-	 * @param {MessageAttachment | MessageAttachment[]} attachment
+	 * @param {MessageAttachment | MessageAttachment[]} [attachment]
 	 * @returns {boolean}
 	 */
 	protected _containsInlinedHtml(
@@ -240,7 +240,7 @@ export class SMTPClient {
 
 	/**
 	 * @protected
-	 * @param {MessageAttachment} attachment
+	 * @param {MessageAttachment} [attachment]
 	 * @returns {boolean}
 	 */
 	protected _isAttachmentInlinedHtml(attachment?: MessageAttachment) {

smtp/connection.ts

@@ -785,11 +785,15 @@ export class SMTPConnection extends EventEmitter {
 
 			/**
 			 * handle bad responses from command differently
-			 * @param {Error} err
-			 * @param {unknown} data
+			 * @param {Error | SMTPError | null} err
+			 * @param {(
+			 * 	string |
+			 * 	{ code: (string | number), data: string, message: string } |
+			 * 	null
+			 * )} [data]
 			 * @returns {void}
 			 */
-			const failed = (err: Error, data: unknown) => {
+			const failed: SMTPCommandCallback = (err, data) => {
 				this.loggedin = false;
 				this.close(); // if auth is bad, close the connection, it won't get better by itself
 				callback(

smtp/date.ts

@@ -1,6 +1,6 @@
 /**
- * @param {Date} [date] an optional date to convert to RFC2822 format
- * @param {boolean} [useUtc] whether to parse the date as UTC (default: false)
+ * @param {Date} [date=new Date()] an optional date to convert to RFC2822 format
+ * @param {boolean} [useUtc=false] whether to parse the date as UTC (default: false)
  * @returns {string} the converted date
  */
 export function getRFC2822Date(date = new Date(), useUtc = false) {
@@ -24,7 +24,7 @@ export function getRFC2822Date(date = new Date(), useUtc = false) {
 }
 
 /**
- * @param {Date} [date] an optional date to convert to RFC2822 format (UTC)
+ * @param {Date} [date=new Date()] an optional date to convert to RFC2822 format (UTC)
  * @returns {string} the converted date
  */
 export function getRFC2822DateUTC(date = new Date()) {

smtp/mime.ts

@@ -71,7 +71,7 @@ function encodeBase64(data: Uint8Array) {
  * Splits a mime encoded string. Needed for dividing mime words into smaller chunks
  *
  * @param {string} str Mime encoded string to be split up
- * @param {number} maxlen Maximum length of characters for one part (minimum 12)
+ * @param {number} [maxlen=12] Maximum length of characters for one part (minimum 12)
  * @return {string[]} lines
  */
 function splitMimeEncodedString(str: string, maxlen = 12) {
@@ -127,17 +127,17 @@ function checkRanges(nr: number) {
 
 /**
  * Encodes all non printable and non ascii bytes to =XX form, where XX is the
- * byte value in hex. This function does not convert linebreaks etc. it
- * only escapes character sequences
+ * byte value in hex. This function only escapes character sequences; it does not
+ * convert linebreaks etc.
  *
- * NOTE: Encoding support depends on util.TextDecoder, which is severely limited
+ * NOTE: Encoding support depends on `util.TextDecoder`, which lacks full ICU support
  * prior to Node.js 13.
  *
  * @see https://nodejs.org/api/util.html#util_whatwg_supported_encodings
  * @see https://github.com/nodejs/node/issues/19214
  *
- * @param {string|Uint8Array} data Either a string or an Uint8Array
- * @param {string} encoding WHATWG supported encoding
+ * @param {string | Uint8Array} [data='']
+ * @param {string} [encoding='utf-8'] WHATWG supported encoding
  * @return {string} Mime encoded string
  */
 export function mimeEncode(data: string | Uint8Array = '', encoding = 'utf-8') {
@@ -168,16 +168,16 @@ export function mimeEncode(data: string | Uint8Array = '', encoding = 'utf-8') {
 /**
  * Encodes a string or an Uint8Array to an UTF-8 MIME Word
  *
- * NOTE: Encoding support depends on util.TextDecoder, which is severely limited
+ * NOTE: Encoding support depends on `util.TextDecoder`, which lacks full ICU support
  * prior to Node.js 13.
  *
  * @see https://tools.ietf.org/html/rfc2047
  * @see https://nodejs.org/api/util.html#util_whatwg_supported_encodings
  * @see https://github.com/nodejs/node/issues/19214
  *
- * @param {string|Uint8Array} data String to be encoded
- * @param {'Q' | 'B'} mimeWordEncoding='Q' Encoding for the mime word, either Q or B
- * @param {string} encoding WHATWG supported encoding
+ * @param {string | Uint8Array} data
+ * @param {'Q' | 'B'} [mimeWordEncoding='Q']
+ * @param {string} [encoding='utf-8'] WHATWG supported encoding
  * @return {string} Single or several mime words joined together
  */
 export function mimeWordEncode(

smtp/response.ts

@@ -5,6 +5,11 @@ import type { TLSSocket } from 'tls';
 export class SMTPResponseMonitor {
 	public readonly stop: (err?: Error) => void;
 
+	/**
+	 * @param {Socket | TLSSocket} stream
+	 * @param {number} timeout
+	 * @param {function(Error): void} onerror
+	 */
 	constructor(
 		stream: Socket | TLSSocket,
 		timeout: number,