Skip to content

Commit d6d0881

Browse files
Add readme
1 parent 980f588 commit d6d0881

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# purescript-node-http2
2+
3+
PureScript bindings to the `http2` Node.js module
4+
5+
## Usage
6+
7+
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).
8+
9+
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.
10+
11+
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 commit comments

Comments
 (0)