Nym DocsNetworkNetworkDevelopersDevelopersOperatorsOperatorsAPIsAPIs
GitHubGitHub (opens in a new tab)Network ExplorerMatrix Logo
  • Overview
    • Exit Security
    • Message Queue & Cover Traffic
  • Rust
  • smolmix (TCP/UDP tunnel)
  • nym-sdk
    • Tour
    • Installation
    • Mixnet Module
      • Tutorial
      • Examples
      • Troubleshooting
    • Stream Module
      • Tutorial
      • Architecture
      • Examples
    • TcpProxy Module (Deprecated)
    • Client Pool Module
      • Tutorial
      • Examples
    • FFI
  • TypeScript
  • Playground (embedded clients)
  • mix-tunnel (shared tunnel)
    • Get started
    • Reference
      • API Index
        • disconnectMixTunnel
        • getMixTunnel
        • getTunnelState
        • proxy
        • setupMixTunnel
        • IMixTunnelWorker
        • LoadedEvent
        • MixFetchResponseInit
        • SetupMixTunnelOpts
        • TunnelState
        • EventKinds
        • TunnelStateName
        • WsEventCallback
        • WsEventType
  • mix-fetch (HTTPS requests)
    • Get started
    • Reference
    • Concepts & security
    • Migrating from v1.x
      • API Index
        • createMixFetch
        • disconnectMixTunnel
        • getTunnelState
        • mixFetch
        • setupMixTunnel
        • SetupMixTunnelOpts
  • mix-dns (DNS resolution)
    • Get started
    • Reference & security
      • API Index
        • disconnectMixTunnel
        • getTunnelState
        • mixDNS
        • setupMixTunnel
        • SetupMixTunnelOpts
  • mix-websocket (ws / wss)
    • Get started
    • Reference
    • Concepts & security
      • API Index
        • MixWebSocket
        • disconnectMixTunnel
        • getTunnelState
          • Returns
          • Source
        • setupMixTunnel
        • SetupMixTunnelOpts
        • MixWebSocketReadyState
  • mix-* Family Architecture
  • Raw Messaging SDK
    • Quick Start
    • Smart Contracts
    • Cosmos Kit
      • General
      • ESBuild
      • Webpack
        • API Index
          • createNymMixnetClient
          • BinaryMessageReceivedEvent
          • Client
          • ConnectedEvent
          • Events
          • LoadedEvent
          • NymMixnetClient
          • NymMixnetClientOptions
          • Payload
          • RawMessageReceivedEvent
          • StringMessageReceivedEvent
          • EventKinds
          • MimeTypes
          • EventHandlerFn
          • EventHandlerSubscribeFn
          • EventHandlerUnsubscribeFn
  • Extras
  • Nym VPN CLI
  • Interacting with Nyx Blockchain
    • CLI Wallet
    • Ledger Live
    • Cosmos Registry
    • RPC Nodes
  • Tools
    • Nym-cli
      • Usage
      • Commands
    • Diagnostic Tool
    • TcpProxy Binaries (Standalone)
    • SOCKS Proxy
      • Setup
      • Usage
      • Config
      • Commands
    • Websocket
      • Setup
      • Usage
      • Config
      • Examples
      • Commands
    • WebAssembly Client
    • Nym Connect
  • Licensing
  • Coc
Developers
mix-websocket (ws / wss)
TypeDoc Reference
Functions
getTunnelState

@nymproject/mix-websocket • Docs

@nymproject/mix-websocket / getTunnelState

Function: getTunnelState()

getTunnelState(): Promise<TunnelState>

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

Returns

Promise<TunnelState>

Source

dev/work/nym/sdk/typescript/packages/mix-tunnel/dist/esm/index.d.ts:18

disconnectMixTunnelsetupMixTunnel
MIT 2026 © Nextra.