80 lines
1.5 KiB
Markdown
80 lines
1.5 KiB
Markdown
[](https://travis-ci.org/icyrockcom/purescript-cheerio)
|
|
|
|
## Description
|
|
|
|
Basic bindings for [cheerio](https://cheerio.js.org/). Only includes read-only functionality for now.
|
|
|
|
## Installation
|
|
|
|
Install [cheerio](https://www.npmjs.com/package/cheerio) dependency:
|
|
|
|
```bash
|
|
$ npm install --save cheerio
|
|
```
|
|
|
|
Install this package using [spago](https://github.com/purescript/spago):
|
|
|
|
* Add package to your `spago.dhall`:
|
|
|
|
```dhall
|
|
...
|
|
dependencies = [ ..., "cheerio" ]
|
|
...
|
|
```
|
|
|
|
* Install packages by running:
|
|
|
|
```bash
|
|
$ spago install
|
|
```
|
|
|
|
## Example
|
|
|
|
From [basic example](examples/Basic.purs).
|
|
|
|
Imports:
|
|
|
|
```purescript
|
|
import Cheerio (Cheerio, find, length)
|
|
import Cheerio.Static (loadRoot)
|
|
```
|
|
|
|
Example html:
|
|
|
|
```purescript
|
|
htmlEx :: String
|
|
htmlEx = """
|
|
<ul id="fruits">
|
|
<li class="apple">Apple</li>
|
|
<li class="orange">Orange</li>
|
|
<li class="pear">Pear</li>
|
|
</ul>
|
|
"""
|
|
```
|
|
|
|
Load it and get the root element:
|
|
|
|
```purescript
|
|
root :: Cheerio
|
|
root = loadRoot htmlEx
|
|
```
|
|
|
|
Use the query functions:
|
|
|
|
```purescript
|
|
let fruitCount = root # find "#fruits" # find "li" # length
|
|
in log $ "Number of fruits: " <> show fruitCount
|
|
```
|
|
|
|
For more examples, please take a look at the [unit tests](test/Test/Main.purs). They cover most of the read-only cheerio functions.
|
|
|
|
## Issues or suggestions
|
|
|
|
If you run into any issues or have suggestions, please open an issue or submit a pull request. Both are welcome!
|
|
|
|
Be prepared to wait more than a couple of days for a response though :)
|
|
|
|
## License
|
|
|
|
MIT
|