bhttp-js
v0.3.6
Published
A BHTTP (Binary Representation of HTTP Messages) Encoder and Decoder
Readme
Index
Supported Environments
bhttp-js can be used in all JavaScript runtimes which support
Request/Response
interface of
Fetch API:
- Deno: 1.x
- Node.js: 18.x, 19.x, 20.x, 21.x, 22.x
- Bun: 0.x, 1.x
- Cloudflare Workers
- @fastly/js-compute
- Web browsers: Chrome, Edge, Firefox, Safari and so on.
Installation
Deno
Starting from version 0.3.4, bhttp-js is available from the
JSR registry. From this version onwards, please use JSR import
instead of HTTPS import in Deno.
JSR imoprt (recommended on >=0.3.4):
Add bhttp-js package using the commands below:
deno add @dajiaji/bhttpThen, you can use the module from code like this:
import { BHttpDecoder, BHttpEncoder } from "@dajiaji/bhttp";Node.js
Using npm, yarn or pnpm:
npm install bhttp-js
yarn add bhttp-js
pnpm install bhttp-jsUsing jsr:
npx jsr add @dajiaji/bhttp
yarn dlx jsr add @dajiaji/bhttp
pnpm dlx jsr add @dajiaji/bhttpCloudflare Workers
Using jsr:
npx jsr add @dajiaji/bhttp
yarn dlx jsr add @dajiaji/bhttp
pnpm dlx jsr add @dajiaji/bhttpBun
Using jsr:
bunx jsr add @dajiaji/bhttpWeb Browser
Followings are how to use with typical CDNs. Other CDNs can be used as well.
Using esm.sh:
<!-- use a specific version -->
<script type="module">
import { BHttpDecoder, BhttpEncoder } from "https://esm.sh/bhttp-js@<SEMVER>";
// ...
</script>
<!-- use the latest stable version -->
<script type="module">
import { BHttpDecoder, BhttpEncoder } from "https://esm.sh/bhttp-js";
// ...
</script>Using unpkg:
<!-- use a specific version -->
<script type="module">
import {
BHttpDecoder,
BhttpEncoder,
} from "https://unpkg.com/bhttp-js@<SEMVER>/esm/mod.js";
// ...
</script>Usage
This section shows some typical usage examples.
Deno
See samples/deno.
import { BHttpDecoder, BHttpEncoder } from "@dajiaji/bhttp";
const req = new Request("https://www.example.com/hello.txt", {
method: "GET",
headers: {
"User-Agent": "curl/7.16.3 libcurl/7.16.3 OpenSSL/0.9.7l zlib/1.2.3",
"Accept-Language": "en, mi",
},
});
// Encode a Request object to a BHTTP binary string.
const encoder = new BHttpEncoder();
const binReq = await encoder.encodeRequest(req);
// Decode the BHTTP binary string to a Request object.
const decoder = new BHttpDecoder();
const decodedReq = decoder.decodeRequest(binReq);Node.js
See samples/node.
Bun
See samples/bun.
Cloudflare Workers
See samples/cloudflare.
Web Browser
BHTTP client on Web Browser:
<html>
<head></head>
<body>
<script type="module">
import { BHttpDecoder, BHttpEncoder } from "https://esm.sh/bhttp-js@<SEMVER>";
globalThis.doBHttp = async () => {
try {
const encoder = new BHttpEncoder();
const req = new Request("https://target.example/query?foo=bar");
const bReq = await encoder.encodeRequest(req);
const res = await fetch("https://bin.example/to_target", {
method: "POST",
headers: {
"Content-Type": "message/bhttp",
},
body: bReq,
});
const decoder = new BHttpDecoder();
const decodedRes = decoder.decodeResponse(await res.arrayBuffer());
// decodedRes.status === 200;
const body = await decodedRes.text();
// body === "baz"
} catch (err) {
alert(err.message);
}
};
</script>
<button type="button" onclick="doBHttp()">do BHTTP</button>
</body>
</html>Contributing
We welcome all kind of contributions, filing issues, suggesting new features or sending PRs.