@sigx/lynx-http

WHATWG fetch for sigx-lynx — the HTTP transport the Lynx BG runtime doesn't ship. URLSession on iOS, OkHttp on Android, exposed behind the fetch API so portable web code works unchanged.

This completes the web-platform networking split:

| Package | Web analog | | --- | --- | | @sigx/lynx-http | fetch | | @sigx/lynx-websocket | WebSocket | | @sigx/lynx-network | navigator.onLine (status only) |

📚 Documentation

Full API, spec deviations, multipart uploads, streaming/SSE and live examples → sigx.dev/lynx/modules/http/overview

Install

You usually don't. The umbrella @sigx/lynx depends on this package and imports it for its side effect, so every app gets a global fetch (plus Headers, FormData, Response, a UTF-8 TextDecoder) out of the box. Standalone installs (pnpm add @sigx/lynx-http) work the same way. Opt out with excludeModules: ['@sigx/lynx-http'] in signalx.config.ts.

⚠️ Don't call a bare fetch(...) on-device. The Lynx BG runtime wraps the bundle in a factory whose fetch parameter shadows globalThis.fetch. Import it explicitly — import { fetch } from '@sigx/lynx' (recommended) or read globalThis.fetch(...) directly — so it resolves to the sigx implementation. (signalxjs/lynx#373, #378.)

A taste

import { fetch } from '@sigx/lynx'; // required on-device (see warning above)

const res = await fetch('https://api.example.com/items', {
    headers: { Authorization: `Bearer ${token}` },
});
const items = await res.json();

Multipart uploads stream file bytes natively (without crossing the JS bridge), and streaming responses (res.body.getReader()) deliver SSE chunks incrementally. The full API, the spec deviations, request logging (under the http namespace) and the bridge protocol are documented on the docs site.

License

MIT