Files
nym/documentation/docs/pages/developers/mix-tunnel/api/functions/getTunnelState.md
T
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

569 B

@nymproject/mix-tunnelDocs


@nymproject/mix-tunnel / getTunnelState

Function: getTunnelState()

getTunnelState(): Promise<TunnelState>

Inspect the current tunnel state. Pre-setup reads as connecting.

Returns

Promise<TunnelState>

Source

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