### ----------------------------------------------------
### -- URI::Encode
### -- Licenses: BSD-2-Clause-FreeBSD
### -- Authors: David Farrell, Raku community
### -- File: README.md
### ----------------------------------------------------
[![Actions Status](https://github.com/raku-community-modules/URI-Encode/actions/workflows/linux.yml/badge.svg)](https://github.com/raku-community-modules/URI-Encode/actions) [![Actions Status](https://github.com/raku-community-modules/URI-Encode/actions/workflows/macos.yml/badge.svg)](https://github.com/raku-community-modules/URI-Encode/actions) [![Actions Status](https://github.com/raku-community-modules/URI-Encode/actions/workflows/windows.yml/badge.svg)](https://github.com/raku-community-modules/URI-Encode/actions)

NAME
====

URI::Encode - a Raku module for encoding / decoding URIs

SYNOPSIS
========

```raku
use URI::Encode;

# for encoding whole URIs, ignores reserved chars: :/?#[]@!$&'()*+,;=
my $encoded_uri = uri_encode('http://www.example.com/?name=john doe&age=54');

# encode every reserved char
my $encoded_uri_component = uri_encode_component('some text/to encode+ safely');

# remove percent encoding
my $decoded_uri = uri_decode('http://www.example.com/?name=john%20doe&age=54');

# provided for symmetry, is the same as uri_decode()
my $decoded_component = uri_decode_component('some%20text%2Fto%20%2B%20safely');
```

DESCRIPTION
===========

URI::Encode is a module that exports four subroutines:

  * uri_encode - encode a whole URI

  * uri_encode_component - encode every reserved char

  * uri_decode - decode a whole URI

  * uri_decode_component - decode every reserved char

SEE ALSo
========

[`URI`](https://raku.land/github:raku-community-modules/URI) is another implementation that covers this area, including encoding and decoding of URIs.

AUTHOR
======

David Farrell

COPYRIGHT AND LICENSE
=====================

Copyright 2014 - 2015 David Farrell

Copyright 2016 - 2025 Raku Community

This library is free software; you can redistribute it and/or modify it under the FreeBSD license.



