typings: add typing for internal/string_decoder

nodejs · aduh95 · Dec 30, 2021 · Apr 13, 2021 · Apr 14, 2021 · Apr 20, 2021
commit cd2230b9890d2ebccddcd9d1372e0a3f7bb89f54
diff --git a/lib/string_decoder.js b/lib/string_decoder.js
@@ -51,6 +51,11 @@ const kNativeDecoder = Symbol('kNativeDecoder');
 
 // Do not cache `Buffer.isEncoding` when checking encoding names as some
 // modules monkey-patch it to support additional encodings
+/**
+ *
+ * @param {string} enc
+ * @returns {"utf8" | "utf16le" | "hex" | "ascii" | "base64" | "latin1" | "base64url"}
- * @returns {"utf8" | "utf16le" | "hex" | "ascii" | "base64" | "latin1" | "base64url"}
+ * @returns {"utf8" | "utf16le" | "hex" | "ascii"
+ *           | "base64" | "latin1" | "base64url"}
- * @returns {"utf8" | "utf16le" | "hex" | "ascii" | "base64" | "latin1" | "base64url"}
+ * @returns {"utf8" | "utf16le" | "hex" | "ascii"
+ *           | "base64" | "latin1" | "base64url"}
+ */
 function normalizeEncoding(enc) {
   const nenc = internalUtil.normalizeEncoding(enc);
   if (nenc === undefined) {
@@ -68,12 +73,21 @@ for (let i = 0; i < encodings.length; ++i)
 // StringDecoder provides an interface for efficiently splitting a series of
 // buffers into a series of JS strings without breaking apart multi-byte
 // characters.
+/**
+ *
+ * @param {string} encoding
+ */
 function StringDecoder(encoding) {
   this.encoding = normalizeEncoding(encoding);
   this[kNativeDecoder] = Buffer.alloc(kSize);
   this[kNativeDecoder][kEncodingField] = encodingsMap[this.encoding];
 }
 
+/**
+ *
- *
+ * Returns a decoded string, omitting any incomplete multibyte 
+ * characters at the end of the Buffer, or TypedArray, or DataView
- *
+ * Returns a decoded string, omitting any incomplete multibyte 
+ * characters at the end of the Buffer, or TypedArray, or DataView
+ * @param {string | Buffer | TypedArray | DataView} buf
+ * @returns {string}
+ */
 StringDecoder.prototype.write = function write(buf) {
   if (typeof buf === 'string')
     return buf;
@@ -84,6 +98,11 @@ StringDecoder.prototype.write = function write(buf) {
   return decode(this[kNativeDecoder], buf);
 };
 
+/**
+ *
- *
+ * Returns any remaining input stored in the internal buffer as a string.
+ * After end() is called, the stringDecoder object can be reused for new input.
- *
+ * Returns any remaining input stored in the internal buffer as a string.
+ * After end() is called, the stringDecoder object can be reused for new input.
+ * @param {string | Buffer | TypedArray | DataView} buf
+ * @returns {string}
+ */
 StringDecoder.prototype.end = function end(buf) {
   let ret = '';
   if (buf !== undefined)
@@ -94,6 +113,12 @@ StringDecoder.prototype.end = function end(buf) {
 };
 
 /* Everything below this line is undocumented legacy stuff. */
+/**
+ *
+ * @param {string | Buffer | TypedArray | DataView} buf
+ * @param {number} offset
+ * @returns {string}
+ */
 StringDecoder.prototype.text = function text(buf, offset) {
   this[kNativeDecoder][kMissingBytes] = 0;
   this[kNativeDecoder][kBufferedBytes] = 0;