Skip to content

Commit ad2b7a6

Browse files
authored
Document encodeURIComponent/encodeURI's argument as unencoded (#48803)
1 parent 9469f95 commit ad2b7a6

6 files changed

+72
-72
lines changed

src/lib/es5.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,13 @@ declare function decodeURIComponent(encodedURIComponent: string): string;
5252

5353
/**
5454
* Encodes a text string as a valid Uniform Resource Identifier (URI)
55-
* @param uri A value representing an encoded URI.
55+
* @param uri A value representing an unencoded URI.
5656
*/
5757
declare function encodeURI(uri: string): string;
5858

5959
/**
6060
* Encodes a text string as a valid component of a Uniform Resource Identifier (URI).
61-
* @param uriComponent A value representing an encoded URI component.
61+
* @param uriComponent A value representing an unencoded URI component.
6262
*/
6363
declare function encodeURIComponent(uriComponent: string | number | boolean): string;
6464

tests/baselines/reference/completionsCommentsClass.baseline

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1340,7 +1340,7 @@
13401340
"kind": "space"
13411341
},
13421342
{
1343-
"text": "A value representing an encoded URI.",
1343+
"text": "A value representing an unencoded URI.",
13441344
"kind": "text"
13451345
}
13461346
]
@@ -1453,7 +1453,7 @@
14531453
"kind": "space"
14541454
},
14551455
{
1456-
"text": "A value representing an encoded URI component.",
1456+
"text": "A value representing an unencoded URI component.",
14571457
"kind": "text"
14581458
}
14591459
]

tests/baselines/reference/completionsCommentsClassMembers.baseline

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -2369,7 +2369,7 @@
23692369
"kind": "space"
23702370
},
23712371
{
2372-
"text": "A value representing an encoded URI.",
2372+
"text": "A value representing an unencoded URI.",
23732373
"kind": "text"
23742374
}
23752375
]
@@ -2482,7 +2482,7 @@
24822482
"kind": "space"
24832483
},
24842484
{
2485-
"text": "A value representing an encoded URI component.",
2485+
"text": "A value representing an unencoded URI component.",
24862486
"kind": "text"
24872487
}
24882488
]
@@ -9430,7 +9430,7 @@
94309430
"kind": "space"
94319431
},
94329432
{
9433-
"text": "A value representing an encoded URI.",
9433+
"text": "A value representing an unencoded URI.",
94349434
"kind": "text"
94359435
}
94369436
]
@@ -9543,7 +9543,7 @@
95439543
"kind": "space"
95449544
},
95459545
{
9546-
"text": "A value representing an encoded URI component.",
9546+
"text": "A value representing an unencoded URI component.",
95479547
"kind": "text"
95489548
}
95499549
]
@@ -14244,7 +14244,7 @@
1424414244
"kind": "space"
1424514245
},
1424614246
{
14247-
"text": "A value representing an encoded URI.",
14247+
"text": "A value representing an unencoded URI.",
1424814248
"kind": "text"
1424914249
}
1425014250
]
@@ -14357,7 +14357,7 @@
1435714357
"kind": "space"
1435814358
},
1435914359
{
14360-
"text": "A value representing an encoded URI component.",
14360+
"text": "A value representing an unencoded URI component.",
1436114361
"kind": "text"
1436214362
}
1436314363
]
@@ -21305,7 +21305,7 @@
2130521305
"kind": "space"
2130621306
},
2130721307
{
21308-
"text": "A value representing an encoded URI.",
21308+
"text": "A value representing an unencoded URI.",
2130921309
"kind": "text"
2131021310
}
2131121311
]
@@ -21418,7 +21418,7 @@
2141821418
"kind": "space"
2141921419
},
2142021420
{
21421-
"text": "A value representing an encoded URI component.",
21421+
"text": "A value representing an unencoded URI component.",
2142221422
"kind": "text"
2142321423
}
2142421424
]
@@ -25370,7 +25370,7 @@
2537025370
"kind": "space"
2537125371
},
2537225372
{
25373-
"text": "A value representing an encoded URI.",
25373+
"text": "A value representing an unencoded URI.",
2537425374
"kind": "text"
2537525375
}
2537625376
]
@@ -25483,7 +25483,7 @@
2548325483
"kind": "space"
2548425484
},
2548525485
{
25486-
"text": "A value representing an encoded URI component.",
25486+
"text": "A value representing an unencoded URI component.",
2548725487
"kind": "text"
2548825488
}
2548925489
]
@@ -30591,7 +30591,7 @@
3059130591
"kind": "space"
3059230592
},
3059330593
{
30594-
"text": "A value representing an encoded URI.",
30594+
"text": "A value representing an unencoded URI.",
3059530595
"kind": "text"
3059630596
}
3059730597
]
@@ -30704,7 +30704,7 @@
3070430704
"kind": "space"
3070530705
},
3070630706
{
30707-
"text": "A value representing an encoded URI component.",
30707+
"text": "A value representing an unencoded URI component.",
3070830708
"kind": "text"
3070930709
}
3071030710
]
@@ -34610,7 +34610,7 @@
3461034610
"kind": "space"
3461134611
},
3461234612
{
34613-
"text": "A value representing an encoded URI.",
34613+
"text": "A value representing an unencoded URI.",
3461434614
"kind": "text"
3461534615
}
3461634616
]
@@ -34723,7 +34723,7 @@
3472334723
"kind": "space"
3472434724
},
3472534725
{
34726-
"text": "A value representing an encoded URI component.",
34726+
"text": "A value representing an unencoded URI component.",
3472734727
"kind": "text"
3472834728
}
3472934729
]
@@ -39785,7 +39785,7 @@
3978539785
"kind": "space"
3978639786
},
3978739787
{
39788-
"text": "A value representing an encoded URI.",
39788+
"text": "A value representing an unencoded URI.",
3978939789
"kind": "text"
3979039790
}
3979139791
]
@@ -39898,7 +39898,7 @@
3989839898
"kind": "space"
3989939899
},
3990039900
{
39901-
"text": "A value representing an encoded URI component.",
39901+
"text": "A value representing an unencoded URI component.",
3990239902
"kind": "text"
3990339903
}
3990439904
]
@@ -45006,7 +45006,7 @@
4500645006
"kind": "space"
4500745007
},
4500845008
{
45009-
"text": "A value representing an encoded URI.",
45009+
"text": "A value representing an unencoded URI.",
4501045010
"kind": "text"
4501145011
}
4501245012
]
@@ -45119,7 +45119,7 @@
4511945119
"kind": "space"
4512045120
},
4512145121
{
45122-
"text": "A value representing an encoded URI component.",
45122+
"text": "A value representing an unencoded URI component.",
4512345123
"kind": "text"
4512445124
}
4512545125
]
@@ -50227,7 +50227,7 @@
5022750227
"kind": "space"
5022850228
},
5022950229
{
50230-
"text": "A value representing an encoded URI.",
50230+
"text": "A value representing an unencoded URI.",
5023150231
"kind": "text"
5023250232
}
5023350233
]
@@ -50340,7 +50340,7 @@
5034050340
"kind": "space"
5034150341
},
5034250342
{
50343-
"text": "A value representing an encoded URI component.",
50343+
"text": "A value representing an unencoded URI component.",
5034450344
"kind": "text"
5034550345
}
5034650346
]
@@ -55448,7 +55448,7 @@
5544855448
"kind": "space"
5544955449
},
5545055450
{
55451-
"text": "A value representing an encoded URI.",
55451+
"text": "A value representing an unencoded URI.",
5545255452
"kind": "text"
5545355453
}
5545455454
]
@@ -55561,7 +55561,7 @@
5556155561
"kind": "space"
5556255562
},
5556355563
{
55564-
"text": "A value representing an encoded URI component.",
55564+
"text": "A value representing an unencoded URI component.",
5556555565
"kind": "text"
5556655566
}
5556755567
]
@@ -59508,7 +59508,7 @@
5950859508
"kind": "space"
5950959509
},
5951059510
{
59511-
"text": "A value representing an encoded URI.",
59511+
"text": "A value representing an unencoded URI.",
5951259512
"kind": "text"
5951359513
}
5951459514
]
@@ -59621,7 +59621,7 @@
5962159621
"kind": "space"
5962259622
},
5962359623
{
59624-
"text": "A value representing an encoded URI component.",
59624+
"text": "A value representing an unencoded URI component.",
5962559625
"kind": "text"
5962659626
}
5962759627
]
@@ -63568,7 +63568,7 @@
6356863568
"kind": "space"
6356963569
},
6357063570
{
63571-
"text": "A value representing an encoded URI.",
63571+
"text": "A value representing an unencoded URI.",
6357263572
"kind": "text"
6357363573
}
6357463574
]
@@ -63681,7 +63681,7 @@
6368163681
"kind": "space"
6368263682
},
6368363683
{
63684-
"text": "A value representing an encoded URI component.",
63684+
"text": "A value representing an unencoded URI component.",
6368563685
"kind": "text"
6368663686
}
6368763687
]
@@ -67628,7 +67628,7 @@
6762867628
"kind": "space"
6762967629
},
6763067630
{
67631-
"text": "A value representing an encoded URI.",
67631+
"text": "A value representing an unencoded URI.",
6763267632
"kind": "text"
6763367633
}
6763467634
]
@@ -67741,7 +67741,7 @@
6774167741
"kind": "space"
6774267742
},
6774367743
{
67744-
"text": "A value representing an encoded URI component.",
67744+
"text": "A value representing an unencoded URI component.",
6774567745
"kind": "text"
6774667746
}
6774767747
]
@@ -71688,7 +71688,7 @@
7168871688
"kind": "space"
7168971689
},
7169071690
{
71691-
"text": "A value representing an encoded URI.",
71691+
"text": "A value representing an unencoded URI.",
7169271692
"kind": "text"
7169371693
}
7169471694
]
@@ -71801,7 +71801,7 @@
7180171801
"kind": "space"
7180271802
},
7180371803
{
71804-
"text": "A value representing an encoded URI component.",
71804+
"text": "A value representing an unencoded URI component.",
7180571805
"kind": "text"
7180671806
}
7180771807
]
@@ -75748,7 +75748,7 @@
7574875748
"kind": "space"
7574975749
},
7575075750
{
75751-
"text": "A value representing an encoded URI.",
75751+
"text": "A value representing an unencoded URI.",
7575275752
"kind": "text"
7575375753
}
7575475754
]
@@ -75861,7 +75861,7 @@
7586175861
"kind": "space"
7586275862
},
7586375863
{
75864-
"text": "A value representing an encoded URI component.",
75864+
"text": "A value representing an unencoded URI component.",
7586575865
"kind": "text"
7586675866
}
7586775867
]
@@ -79808,7 +79808,7 @@
7980879808
"kind": "space"
7980979809
},
7981079810
{
79811-
"text": "A value representing an encoded URI.",
79811+
"text": "A value representing an unencoded URI.",
7981279812
"kind": "text"
7981379813
}
7981479814
]
@@ -79921,7 +79921,7 @@
7992179921
"kind": "space"
7992279922
},
7992379923
{
79924-
"text": "A value representing an encoded URI component.",
79924+
"text": "A value representing an unencoded URI component.",
7992579925
"kind": "text"
7992679926
}
7992779927
]
@@ -84209,7 +84209,7 @@
8420984209
"kind": "space"
8421084210
},
8421184211
{
84212-
"text": "A value representing an encoded URI.",
84212+
"text": "A value representing an unencoded URI.",
8421384213
"kind": "text"
8421484214
}
8421584215
]
@@ -84322,7 +84322,7 @@
8432284322
"kind": "space"
8432384323
},
8432484324
{
84325-
"text": "A value representing an encoded URI component.",
84325+
"text": "A value representing an unencoded URI component.",
8432684326
"kind": "text"
8432784327
}
8432884328
]
@@ -89567,7 +89567,7 @@
8956789567
"kind": "space"
8956889568
},
8956989569
{
89570-
"text": "A value representing an encoded URI.",
89570+
"text": "A value representing an unencoded URI.",
8957189571
"kind": "text"
8957289572
}
8957389573
]
@@ -89680,7 +89680,7 @@
8968089680
"kind": "space"
8968189681
},
8968289682
{
89683-
"text": "A value representing an encoded URI component.",
89683+
"text": "A value representing an unencoded URI component.",
8968489684
"kind": "text"
8968589685
}
8968689686
]
@@ -94181,7 +94181,7 @@
9418194181
"kind": "space"
9418294182
},
9418394183
{
94184-
"text": "A value representing an encoded URI.",
94184+
"text": "A value representing an unencoded URI.",
9418594185
"kind": "text"
9418694186
}
9418794187
]
@@ -94294,7 +94294,7 @@
9429494294
"kind": "space"
9429594295
},
9429694296
{
94297-
"text": "A value representing an encoded URI component.",
94297+
"text": "A value representing an unencoded URI component.",
9429894298
"kind": "text"
9429994299
}
9430094300
]

0 commit comments

Comments
 (0)