Skip to content

purescript-contrib/purescript-affjax

Repository files navigation

Affjax

CI Release Pursuit Maintainer: garyb

A library taking advantage of aff to enable pain-free asynchronous AJAX requests and response handling.

This library provides types and common functionality that work across environments (e.g. Node, browser), but it does not work out-of-box. Rather, use the environment-specific library instead:

Documentation

affjax documentation is stored in a few places:

  1. Module documentation is published on Pursuit.
  2. Written documentation is kept in the docs directory.
  3. 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 affjax 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.