A FormURLEncoded
datatype represents an ordered list of key-value pairs with possible duplicates. The encode
function allows to transform FormURLEncoded
into a Maybe String
according to application/x-www-form-urlencoded
. The decode
function transforms a string into a Maybe FormURLEncoded
structure.
Install form-urlencoded
with Spago:
spago install form-urlencoded
Use the encode
function to properly encode an array of key-value pairs, and the decode
function to decode an encoded string.
> import Data.FormURLEncoded (fromArray, encode)
> import Data.Maybe (Maybe(..))
> import Data.Tuple (Tuple(..))
> encode $ fromArray
> [ Tuple "hey" Nothing
> , Tuple "Oh" (Just "Let's go!")
> ]
Just "hey&Oh=Let's%20go!"
> decode "a=aa&b=bb"
Just (FormURLEncoded [(Tuple "a" (Just "aa")),(Tuple "b" (Just "bb"))])
form-urlencoded
documentation is stored in a few places:
- Module documentation is published on Pursuit.
- Written documentation is kept in the docs directory.
- Usage examples can be found in the test suite.
If you get stuck, there are several ways to get help:
- Open an issue if you have encountered a bug or problem.
- Search or start a thread on the PureScript Discourse if you have general questions. You can also ask questions in the
#purescript
and#purescript-beginners
channels on the Functional Programming Slack (invite link).
You can contribute to form-urlencoded
in several ways:
-
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.
-
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.
-
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.