https://github.com/purescript-contrib/purescript-uri

A type-safe parser, printer, and ADT for URLs and URIs.
https://github.com/purescript-contrib/purescript-uri

Last synced: 15 days ago
JSON representation

A type-safe parser, printer, and ADT for URLs and URIs.

• Host: GitHub
• URL: https://github.com/purescript-contrib/purescript-uri
• Owner: purescript-contrib
• License: apache-2.0
• Created: 2015-05-03T17:17:59.000Z (almost 11 years ago)
• Default Branch: main
• Last Pushed: 2022-04-28T00:21:11.000Z (almost 4 years ago)
• Last Synced: 2026-01-13T05:27:23.047Z (2 months ago)
• Language: PureScript
• Homepage:
• Size: 371 KB
• Stars: 26
• Watchers: 11
• Forks: 23
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# URI

[![CI](https://github.com/purescript-contrib/purescript-uri/workflows/CI/badge.svg?branch=main)](https://github.com/purescript-contrib/purescript-uri/actions?query=workflow%3ACI+branch%3Amain)

[![Release](http://img.shields.io/github/release/purescript-contrib/purescript-uri.svg)](https://github.com/purescript-contrib/purescript-uri/releases)

[![Pursuit](http://pursuit.purescript.org/packages/purescript-uri/badge)](http://pursuit.purescript.org/packages/purescript-uri)

[![Maintainer: garyb](https://img.shields.io/badge/maintainer-garyb-teal.svg)](http://github.com/garyb)

A type-safe parser, printer, and ADT for URLs and URIs based on [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986.html).

## Installation

Install `uri` with [Spago](https://github.com/purescript/spago):

```sh

spago install uri

```

## Quick start

The quick start hasn't been written yet (contributions are welcome!). The quick start covers a common, minimal use case for the library, whereas longer examples and tutorials are kept in the [docs directory](./docs).

## Documentation

`uri` documentation is stored in a few places:

1. Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-uri).

2. Written documentation is kept in [the docs directory](./docs).

3. Usage examples can be found in [the test suite](./test).

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

- [Open an issue](https://github.com/purescript-contrib/purescript-uri/issues) if you have encountered a bug or problem.

- Ask general questions on the [PureScript Discourse](https://discourse.purescript.org) forum or the [PureScript Discord](https://purescript.org/chat) chat.

## Contributing

You can contribute to `uri` in several ways:

1. If you encounter a problem or have a question, please [open an issue](https://github.com/purescript-contrib/purescript-uri/issues). 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](./CONTRIBUTING.md). 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](https://discourse.purescript.org)! Writing libraries and learning resources are a great way to help this library succeed.