encodeurl 1.0.2

Encodeurl is a popular Node.js module available through the npm registry. It's designed to encode a URL into a percent-encoded form, excluding sequences that have already been encoded. The purpose is to render safe and properly formatted URLs. Importantly, it also ensures not to encode "%" character if it's part of a valid encoded sequence.

To use encodeurl in your JavaScript project, you first need to install it by running npm install encodeurl in your project directory using your terminal. Once installed, you can import the function with var encodeUrl = require('encodeurl') and use it to encode any URL.

Here are a few examples how to use encodeurl:

var encodeUrl = require('encodeurl')
var escapeHtml = require('escape-html')

http.createServer(function onRequest (req, res) {
  var url = encodeUrl(req.url)
  var body = '<p>Location ' + escapeHtml(url) + ' not found</p>'
  res.statusCode = 404
  res.setHeader('Content-Type', 'text/html; charset=UTF-8')
  res.setHeader('Content-Length', String(Buffer.byteLength(body, 'utf-8')))
  res.end(body, 'utf-8')
})

And here's another example:

var encodeUrl = require('encodeurl')
var escapeHtml = require('escape-html')
var url = require('url')

http.createServer(function onRequest (req, res) {
  var href = url.parse(req)
  href.host = 'localhost'
  href.protocol = 'https:'
  href.slashes = true

  var location = encodeUrl(url.format(href))
  var body = '<p>Redirecting to new site: ' + escapeHtml(location) + '</p>'
  res.statusCode = 301
  res.setHeader('Content-Type', 'text/html; charset=UTF-8')
  res.setHeader('Content-Length', String(Buffer.byteLength(body, 'utf-8')))
  res.setHeader('Location', location)
  res.end(body, 'utf-8')
})

You can find the documentation for encodeurl on the GitHub page of the project: https://github.com/pillarjs/encodeurl. Additionally, the package's npm page probably contains valuable information: https://www.npmjs.com/package/encodeurl. In these resources, you can find information about its methods, usage examples, and other details about the package.