Files
mfahampshire 7c890ea0c5 TS SDK docs (#6840)
* First sweep packages + some minor tweaking

* Second sweep

* Regenerate lockfile + package.json mods

* Regenerate lockfile again

* Fix CI

* Fix CI again

* All building properly

* unblock

* Tweak examples

* Comments + readme + fix rotten unit test

* First pass docs

* Big pass

* Massive pass on new docs

* Update integrations.md w mobile

* Partial overhaul review

* new playground + big pass

* new fix lychee err

* IPR notice tweak
2026-06-09 13:31:08 +00:00

859 B

@nymproject/mix-tunnelDocs


@nymproject/mix-tunnel / getMixTunnel

Function: getMixTunnel()

getMixTunnel(): Promise<Remote<IMixTunnelWorker>>

Get the singleton tunnel worker handle. The first call spawns the worker and loads smolmix-wasm; subsequent calls return the same handle.

Note: this does NOT call setupMixTunnel automatically. Call it on the returned handle (or use the top-level setupMixTunnel helper) before issuing fetch/dns/websocket requests.

Returns

Promise<Remote<IMixTunnelWorker>>

Source

sdk/typescript/packages/mix-tunnel/src/index.ts:47