eleith
/
emailjs
mirror of https://github.com/eleith/emailjs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

chore: use @note jsdoc tag

This commit is contained in:
Zack Schuster 2022-06-14 10:13:54 -07:00
parent 194e2c0c2a
commit d2b6e3cd70
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
smtp/client.ts
View File

@ -33,7 +33,7 @@ export class SMTPClient {
/**
* Create a standard SMTP client backed by a self-managed SMTP connection.
*
* NOTE: `host` is trimmed before being used to establish a connection; however, the original untrimmed value will still be visible in configuration.
* @note `host` is trimmed before being used to establish a connection; however, the original untrimmed value will still be visible in configuration.
*
* @param {Partial<SMTPConnectionOptions>} server smtp options
*/

4
smtp/connection.ts
View File

@ -125,7 +125,7 @@ export class SMTPConnection extends EventEmitter {
*
* To target a Message Transfer Agent (MTA), omit all options.
*
* NOTE: `host` is trimmed before being used to establish a connection; however, the original untrimmed value will still be visible in configuration.
* @note `host` is trimmed before being used to establish a connection; however, the original untrimmed value will still be visible in configuration.
*
* @param {Partial<SMTPConnectionOptions>} options
*/
@ -219,7 +219,7 @@ export class SMTPConnection extends EventEmitter {
/**
* Establish an SMTP connection.
*
* NOTE: `host` is trimmed before being used to establish a connection; however, the original untrimmed value will still be visible in configuration.
* @note `host` is trimmed before being used to establish a connection; however, the original untrimmed value will still be visible in configuration.
*
* @public
* @param {SMTPCommandCallback} callback

4
smtp/mime.ts
View File

@ -130,7 +130,7 @@ function checkRanges(nr: number) {
* byte value in hex. This function only escapes character sequences; it does not
* convert linebreaks etc.
*
* NOTE: Encoding support depends on `util.TextDecoder`, which lacks full ICU support
* @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
@ -168,7 +168,7 @@ 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 lacks full ICU support
* @note Encoding support depends on `util.TextDecoder`, which lacks full ICU support
* prior to Node.js 13.
*
* @see https://tools.ietf.org/html/rfc2047