https://github.com/melange-community/melange-fetch

Fetch bindings for Melange
https://github.com/melange-community/melange-fetch

bucklescript fetch reasonml

Last synced: about 2 months ago
JSON representation

Fetch bindings for Melange

• Host: GitHub
• URL: https://github.com/melange-community/melange-fetch
• Owner: melange-community
• License: mit
• Created: 2017-03-21T13:21:16.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-03-12T04:21:49.000Z (4 months ago)
• Last Synced: 2024-05-09T07:54:19.590Z (about 2 months ago)
• Topics: bucklescript, fetch, reasonml
• Language: OCaml
• Homepage:
• Size: 102 KB
• Stars: 201
• Watchers: 7
• Forks: 53
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Lists

• awesome-list - bs-fetch - community | 201 | (OCaml)
• awesome-reasonml - melange-fetch - Fetch bindings for Melange (Reason / Libraries)

README

        
# melange-fetch

Low-level bindings to fetch for [Melange](https://melange.re/).

[![Issues](https://img.shields.io/github/issues/melange-community/melange-fetch.svg)](https://github.com/melange-community/melange-fetch/issues)

[![Last Commit](https://img.shields.io/github/last-commit/melange-community/melange-fetch.svg)]()

`melange-fetch` is intended as a thin layer atop the JS API, upon which more

high-level and idiomatic libraries can be made. Once such a library has been

established, these bindings will likely be refactored to be even thinner.

## Example

```reason

Js.Promise.(

  Fetch.fetch("/api/hellos/1")

  |> then_(Fetch.Response.text)

  |> then_(text => print_endline(text) |> resolve)

);

```

## Installation

```sh

opam install melange-fetch

```

Then add `melange-fetch` to the `libraries` field in your dune file:

```lisp

(melange.emit ;; or (library ...)

 ...

 (libraries melange-fetch))

```

## Usage

See usage examples in

[`ocaml_examples.ml`](https://github.com/melange-community/melange-fetch/blob/master/examples/ocaml_examples.ml)

and

[`reason_examples.re`](https://github.com/melange-community/melange-fetch/blob/master/examples/reason_examples.re).

The source is a [single

file](https://github.com/melange-community/melange-fetch/blob/master/src/Fetch.ml)!

## Node.js polyfill

`fetch` is a Web API that isn't available out-of-the-box in Node.js, and will therefore need to be polyfilled. [isomorphic-fetch](https://github.com/matthew-andrews/isomorphic-fetch) one such polyfill that seems to work well. Just install it via npm and add `[%raw "require('isomorphic-fetch')"]` to the top of your main file, but be aware that there are some subtle differences and even parts that are missing entirely.

## Changes

### 0.6.2

- Added `FormData` bindings

### 0.6.0

- Bugfix: `Response._type` was generating `_type` instead of `type`

- Breaking: Rename `Response._type` to `Response.type_` to follow the name mangling convention trends

### 0.5.2

- Added `AbortController`

### 0.5.0

- Fixed `Headers.append` and `Headers.delete`. They were missing the return type.

### 0.4.0

- Bumped `bs-platform` to 5.0.4 to stop compiler from complaining.

### 0.3.0

- Added `HeadersInit.makeWithDict` so as to be able to make headers in OCaml too

- Require `bs-platform` >= 3.0.0 due to internal dependency on Js.boolean that has now been removed

### 0.2.0

- Rename `Bs_fetch` module to `Fetch`. `Bs_fetch` is kept around as an alias for backwards compatibility, but should be considered deprecated.