Join the AI Workshop and learn to build real-world apps with AI. A hands-on, practical program to level up your skills.
How do you encode a URL in JavaScript?
Depending on what you need to do, there are two JavaScript functions that will help you.
The first is encodeURI(), and the second is encodeURIComponent().
Note: you might read about
escape(), but that is deprecated and should not be used.
Differences Between the Two Methods
Those two methods differ in which characters they encode.
In detail:
encodeURI()does not encode~!@#$&*()=:/,;?+encodeURIComponent()does not encode-_.!~*'()
Why do they differ? Because they are meant for different uses:
encodeURI()is meant to encode a full URLencodeURIComponent()is meant to encode a single URL parameter value
If you were to call encodeURIComponent() on a full URL, since it does encode /, the URL path separators would be encoded as well (among other things):
encodeURI("http://flaviocopes.com/ hey!/")
//"http://flaviocopes.com/%20hey!/"
encodeURIComponent("http://www.example.org/a file with spaces.html")
// "http%3A%2F%2Fwww.example.org%2Fa%20file%20with%20spaces.html"
RFC 3986 Compliance
MDN proposes an improvement to adhere to the RFC 3986 standard, by implementing the following function:
const fixedEncodeURIComponent = (str) => {
return encodeURIComponent(str).replace(/[!'()*]/g, (c) => {
return '%' + c.charCodeAt(0).toString(16)
})
}
You call it for every single parameter that you’ll add to the URL.
Decoding
The encodeURI() and encodeURIComponent() methods have corresponding decodeURI() and decodeURIComponent() methods that do the opposite:
decodeURI("http://flaviocopes.com/%20hey!/")
// "http://flaviocopes.com/ hey!/"
decodeURIComponent("http%3A%2F%2Fflaviocopes.com%2F%20hey!%2F")
// "http://flaviocopes.com/ hey!/"