Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JordanMartinez committed Jun 16, 2023
1 parent 980f588 commit d6d0881
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# purescript-node-http2

PureScript bindings to the `http2` Node.js module

## Usage

The bindings for the module have been implemented, excluding the [Compatibility API](https://nodejs.org/dist/latest-v18.x/docs/api/http2.html#compatibility-api).

This repo is incompatible with existing `node-streams` and `node-net` bindings in the default package set. Instead, this repo uses custom forks of [`node-streams@update-ffi-build-on-node-event-emitters`](https://github.com/purescript-node/purescript-node-streams/tree/update-ffi-build-on-node-event-emitters) and [`node-net@fully-implement`](https://github.com/purescript-node/purescript-node-net/tree/fully-implement) that implement their event handlers using the bindings exposed via [`[email protected]`](https://github.com/purescript-node/purescript-node-event-emitter/tree/v2.0.0). See the [packages.dhall](./packages.dhall) file to see how to refer to these forks if you want to use this repo.

The bindings written thus far are mostly safe. There are a few cases where safety cannot be properly handled in PureScript due to some decisions made by Node.js. In other cases, it's not yet clear to me whether to represent something as `foreign import data`, `Object`, and/or an `ADT`.

0 comments on commit d6d0881

Please sign in to comment.