FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

typings: add JSDoc Types to lib/querystring · nodejs/node@8acfe5c · GitHub

/ node Public

Commit 8acfe5c

Browse files
Skn0tt
authored and
targos
committed
typings: add JSDoc Types to lib/querystring
PR-URL: #38185 Reviewed-By: Michaël Zasso <targos@protonmail.com>
1 parent 14aed60 commit 8acfe5c

2 files changed

Lines changed: 69 additions & 11 deletions

File tree

‎lib/internal/querystring.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ const isHexTable = new Int8Array([
3636
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // ... 256
3737
]);
3838

39+
/**
40+
* @param {string} str
41+
* @param {Int8Array} noEscapeTable
42+
* @param {string[]} hexTable
43+
* @returns {string}
44+
*/
3945
function encodeStr(str, noEscapeTable, hexTable) {
4046
const len = str.length;
4147
if (len === 0)

‎lib/querystring.js‎

Lines changed: 63 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,12 @@ const unhexTable = new Int8Array([
7676
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
7777
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, // ... 255
7878
]);
79-
// A safe fast alternative to decodeURIComponent
79+
/**
80+
* A safe fast alternative to decodeURIComponent
81+
* @param {string} s
82+
* @param {boolean} decodeSpaces
83+
* @returns {string}
84+
*/
8085
function unescapeBuffer(s, decodeSpaces) {
8186
const out = Buffer.allocUnsafe(s.length);
8287
let index = 0;
@@ -119,7 +124,11 @@ function unescapeBuffer(s, decodeSpaces) {
119124
return hasHex ? out.slice(0, outIndex) : out;
120125
}
121126

122-
127+
/**
128+
* @param {string} s
129+
* @param {boolean} decodeSpaces
130+
* @returns {string}
131+
*/
123132
function qsUnescape(s, decodeSpaces) {
124133
try {
125134
return decodeURIComponent(s);
@@ -145,8 +154,13 @@ const noEscape = new Int8Array([
145154
0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, // 96 - 111
146155
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 0, // 112 - 127
147156
]);
148-
// QueryString.escape() replaces encodeURIComponent()
149-
// https://www.ecma-international.org/ecma-262/5.1/#sec-15.1.3.4
157+
158+
/**
159+
* QueryString.escape() replaces encodeURIComponent()
160+
* @see https://www.ecma-international.org/ecma-262/5.1/#sec-15.1.3.4
161+
* @param {any} str
162+
* @returns {string}
163+
*/
150164
function qsEscape(str) {
151165
if (typeof str !== 'string') {
152166
if (typeof str === 'object')
@@ -158,6 +172,10 @@ function qsEscape(str) {
158172
return encodeStr(str, noEscape, hexTable);
159173
}
160174

175+
/**
176+
* @param {string | number | bigint | boolean | symbol | undefined | null} v
177+
* @returns {string}
178+
*/
161179
function stringifyPrimitive(v) {
162180
if (typeof v === 'string')
163181
return v;
@@ -170,7 +188,11 @@ function stringifyPrimitive(v) {
170188
return '';
171189
}
172190

173-
191+
/**
192+
* @param {string | number | bigint | boolean} v
193+
* @param {(v: string) => string} encode
194+
* @returns
195+
*/
174196
function encodeStringified(v, encode) {
175197
if (typeof v === 'string')
176198
return (v.length ? encode(v) : '');
@@ -186,12 +208,23 @@ function encodeStringified(v, encode) {
186208
return '';
187209
}
188210

189-
211+
/**
212+
* @param {string | number | boolean | null} v
213+
* @param {(v: string) => string} encode
214+
* @returns {string}
215+
*/
190216
function encodeStringifiedCustom(v, encode) {
191217
return encode(stringifyPrimitive(v));
192218
}
193219

194-
220+
/**
221+
* @param {Record<string, string | number | boolean
222+
* | ReadonlyArray<string | number | boolean> | null>} obj
223+
* @param {string} [sep]
224+
* @param {string} [eq]
225+
* @param {{ encodeURIComponent?: (v: string) => string }} [options]
226+
* @returns {string}
227+
*/
195228
function stringify(obj, sep, eq, options) {
196229
sep = sep || '&';
197230
eq = eq || '=';
@@ -236,6 +269,10 @@ function stringify(obj, sep, eq, options) {
236269
return '';
237270
}
238271

272+
/**
273+
* @param {string} str
274+
* @returns {number[]}
275+
*/
239276
function charCodes(str) {
240277
if (str.length === 0) return [];
241278
if (str.length === 1) return [StringPrototypeCharCodeAt(str, 0)];
@@ -267,7 +304,17 @@ function addKeyVal(obj, key, value, keyEncoded, valEncoded, decode) {
267304
}
268305
}
269306

270-
// Parse a key/val string.
307+
/**
308+
* Parse a key/val string.
309+
* @param {string} qs
310+
* @param {string} sep
311+
* @param {string} eq
312+
* @param {{
313+
* maxKeys?: number;
314+
* decodeURIComponent?(v: string): string;
315+
* }} [options]
316+
* @returns {Record<string, string | string[]>}
317+
*/
271318
function parse(qs, sep, eq, options) {
272319
const obj = ObjectCreate(null);
273320

@@ -421,9 +468,14 @@ function parse(qs, sep, eq, options) {
421468
}
422469

423470

424-
// v8 does not optimize functions with try-catch blocks, so we isolate them here
425-
// to minimize the damage (Note: no longer true as of V8 5.4 -- but still will
426-
// not be inlined).
471+
/**
472+
* V8 does not optimize functions with try-catch blocks, so we isolate them here
473+
* to minimize the damage (Note: no longer true as of V8 5.4 -- but still will
474+
* not be inlined).
475+
* @param {string} s
476+
* @param {(v: string) => string} decoder
477+
* @returns {string}
478+
*/
427479
function decodeStr(s, decoder) {
428480
try {
429481
return decoder(s);

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL