Nym DocsNetworkNetwork
OperatorsOperatorsAPIsAPIs
GitHubGitHub (opens in a new tab)Network ExplorerMatrix Logo
  • Introduction
  • Mixnet Integrations
  • Overview - Start Here!
  • Native Apps
  • Browser Apps
    • Nym Client Message Queue and Cover Traffic
  • SDKs
  • Rust SDK
    • Tour
    • Installation
    • Mixnet Module
      • Tutorial
      • Examples
      • Troubleshooting
    • Stream Module
      • Tutorial
      • Architecture
      • Examples
    • TcpProxy Module (Deprecated)
    • Client Pool Module
      • Tutorial
      • Examples
    • FFI
  • Typescript SDK
      • 1. mixFetch
      • 2. Mixnet Client
      • 3. Nym Smart Contracts
      • 4. Cosmos Kit
      • 1. Use mixFetch
      • 2. Send traffic over the mixnet
      • 3.1. Query mixnet contract for a list of mix nodes
      • 3.2. Basic wallet operations
      • 4. Cosmos Kit
      • General
      • ESBuild
      • Webpack
        • API Index
          • Enumerations
          • Interfaces
          • Type Aliases
          • Functions
          • createNymMixnetClient
          • NymMixnetClient
          • NymMixnetClientOptions
          • Client
          • Events
          • Payload
          • ConnectedEvent
          • LoadedEvent
          • StringMessageReceivedEvent
          • BinaryMessageReceivedEvent
          • RawMessageReceivedEvent
          • EventKinds
          • MimeTypes
          • EventHandlerFn
          • EventHandlerSubscribeFn
          • EventHandlerUnsubscribeFn
        • API Index
          • mixFetch
          • createMixFetch
          • disconnectMixFetch
          • IMixFetch
          • IMixFetchWebWorker
          • ResponseBody
          • ResponseBodyConfigMap
          • MixFetchWebWorkerResponse
          • LoadedEvent
          • EventKinds
          • IMixFetchFn
          • SetupMixFetchOps
          • ResponseBodyMethod
          • ResponseBodyConfigMapDefaults
  • Extras
  • Nym VPN CLI
  • Interacting with Nyx Blockchain
    • CLI Wallet
    • Cosmos Registry
    • Ledger Live
    • Run a Nyx RPC Node for the Nym Network
  • 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
Typescript SDK
TypeDoc Reference
@nymproject/sdk
API Index

@nymproject/sdk • Docs

@nymproject/sdk

Enumerations

  • EventKinds
  • MimeTypes

Interfaces

  • NymMixnetClientOptions
  • NymMixnetClient
  • Client
  • Events
  • LoadedEvent
  • ConnectedEvent
  • StringMessageReceivedEvent
  • BinaryMessageReceivedEvent
  • RawMessageReceivedEvent
  • Payload

Type Aliases

  • EventHandlerSubscribeFn
  • EventHandlerFn
  • EventHandlerUnsubscribeFn

Functions

  • createNymMixnetClient
WebpackcreateNymMixnetClient
MIT 2026 © Nextra.