Skip to content

typings: add typing for string decoder #38229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 30, 2021
Merged

typings: add typing for string decoder #38229

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cd2230b
typings: add typing for internal/string_decoder
Ayase-252 Apr 13, 2021
b9ccd90
fixup: typings: add typing for internal/string_decoder
Ayase-252 Apr 14, 2021
4aee5ee
fixup: add function description
Ayase-252 Apr 20, 2021
1d2dc41
fixup: mark optional parameters
Ayase-252 Apr 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions lib/string_decoder.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ 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"}
*/
function normalizeEncoding(enc) {
const nenc = internalUtil.normalizeEncoding(enc);
if (nenc === undefined) {
Expand All @@ -68,12 +74,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.
/**
*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Move the above description inside the comment?

* @param {string} encoding
*/
function StringDecoder(encoding) {
this.encoding = normalizeEncoding(encoding);
this[kNativeDecoder] = Buffer.alloc(kSize);
this[kNativeDecoder][kEncodingField] = encodingsMap[this.encoding];
}

/**
*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
*
* 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;
Expand All @@ -84,6 +99,11 @@ StringDecoder.prototype.write = function write(buf) {
return decode(this[kNativeDecoder], buf);
};

/**
*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
*
* 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)
Expand All @@ -94,6 +114,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;
Expand Down