https://github.com/purescript-contrib/purescript-affjax-node
https://github.com/purescript-contrib/purescript-affjax-node
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/purescript-contrib/purescript-affjax-node
- Owner: purescript-contrib
- Created: 2022-03-28T22:48:27.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-10-10T13:29:09.000Z (over 3 years ago)
- Last Synced: 2025-08-19T23:35:39.617Z (7 months ago)
- Language: PureScript
- Size: 11.7 KB
- Stars: 3
- Watchers: 8
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# purescript-affjax-node
[](https://github.com/purescript-contrib/purescript-affjax-node/actions?query=workflow%3ACI+branch%3Amain)
[](https://github.com/purescript-contrib/purescript-affjax-node/releases)
[](https://pursuit.purescript.org/packages/purescript-affjax-node)
[](https://github.com/garyb)
The library summary hasn't been written yet (contributions are welcome!). The library summary describes the library's purpose in one to three sentences.
## Installation
Install affjax-node with [Spago](https://github.com/purescript/spago):
```sh
spago install affjax-node
```
And also install `xhr2`
```sh
npm i xhr2
```
## 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
affjax-node documentation is stored in a few places:
1. Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-affjax-node).
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-affjax-node/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://discord.com/invite/sMqwYUbvz6) chat.
## Contributing
You can contribute to affjax-node in several ways:
1. If you encounter a problem or have a question, please [open an issue](https://github.com/purescript-contrib/purescript-affjax-node/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.