JS URI

March 2, 2022 ยท View on GitHub

CI Release Pursuit

URI encoding and decoding functions according to RFC 3986, implemented on top of JavaScript's builtin encodeURIComponent and decodeURIComponent. This library also contains support for encoding and decoding according to application/x-www-form-urlencoded.

Installation

Install js-uri with Spago:

spago install js-uri

Quick start

This library provides functions for encoding and decoding URIs and additional functions that match application/x-www-form-urlencoded. To encode or decode a URI according to RFC3896:

import JSURI (encodeURIComponent, decodeURIComponent)

> encodeURIComponent "https://purescript.org"
Just "https%3A%2F%2Fpurescript.org"

> encodeURIComponent "abc ABC"
Just "abc%20ABC"

> decodeURIComponent "https%3A%2F%2Fpurescript.org" == Just "https://purescript.org"
> decodeURIComponent "https%3A%2F%2Fpurescript.org?search+query" == Just "https://purescript.org?search+query"

To use form-urlencoding instead, which uses + for spaces instead of %20:

import JSURI (encodeFormURLComponent, decodeFormURLComponent)

> encodeFormURLComponent "abc ABC" == Just "abc+ABC"
> decodeFormURLComponent "https%3A%2F%2Fpurescript.org?search+query" == Just "https://purescript.org?search query"

Documentation

js-uri documentation is stored in a few places:

  1. Module documentation is published on Pursuit.
  2. Usage examples can be found in the test suite.

If you get stuck, there are several ways to get help:

Contributing

You can contribute to js-uri in several ways:

  1. If you encounter a problem or have a question, please open an issue. We'll do our best to work with you to resolve or answer it.

  2. If you would like to contribute code, tests, or documentation, please read the contributor guide. It's a short, helpful introduction to contributing to this library, including development instructions.

  3. If you have written a library, tutorial, guide, or other resource based on this package, please share it on the PureScript Discourse! Writing libraries and learning resources are a great way to help this library succeed.