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

An asynchronous effect monad for PureScript
https://github.com/purescript-contrib/purescript-aff

Last synced: about 1 month ago
JSON representation

An asynchronous effect monad for PureScript

• Host: GitHub
• URL: https://github.com/purescript-contrib/purescript-aff
• Owner: purescript-contrib
• License: apache-2.0
• Created: 2015-02-27T21:08:39.000Z (about 10 years ago)
• Default Branch: main
• Last Pushed: 2024-09-08T19:37:56.000Z (7 months ago)
• Last Synced: 2024-10-30T08:17:35.394Z (6 months ago)
• Language: PureScript
• Homepage: https://pursuit.purescript.org/packages/purescript-aff
• Size: 466 KB
• Stars: 285
• Watchers: 20
• Forks: 66
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-purescript - aff - Asynchronous effects. (Essential libraries)

README

        
# Aff

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

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

[![Pursuit](https://pursuit.purescript.org/packages/purescript-aff/badge)](https://pursuit.purescript.org/packages/purescript-aff)

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

An asynchronous effect monad and threading model for PureScript.

## Installation

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

```sh

spago install aff

```

## Quick start

This quick start covers common, minimal use cases for the library. Longer examples and tutorials can be found in the [docs directory](./docs).

```purescript

main :: Effect Unit

main = launchAff_ do

  response <- Ajax.get "http://foo.bar"

  log response.body

```

## Documentation

`aff` documentation is stored in a few places:

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

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-aff/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 `aff` in several ways:

1. If you encounter a problem or have a question, please [open an issue](https://github.com/purescript-contrib/purescript-aff/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.