GRIN/nym

Files

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

4.3 KiB

Raw Permalink Blame History

@nymproject/mix-tunnel • Docs

@nymproject/mix-tunnel / SetupMixTunnelOpts

Interface: SetupMixTunnelOpts

Properties

preferredIpr?

optional preferredIpr: string

Source

sdk/typescript/packages/mix-tunnel/src/types.ts:11

clientId?

optional clientId: string

Source

sdk/typescript/packages/mix-tunnel/src/types.ts:12

forceTls?

optional forceTls: boolean

Source

sdk/typescript/packages/mix-tunnel/src/types.ts:13

disablePoissonTraffic?

optional disablePoissonTraffic: boolean

Source

sdk/typescript/packages/mix-tunnel/src/types.ts:14

disableCoverTraffic?

optional disableCoverTraffic: boolean

Source

sdk/typescript/packages/mix-tunnel/src/types.ts:15

openReplySurbs?

optional openReplySurbs: number

Source

sdk/typescript/packages/mix-tunnel/src/types.ts:16

dataReplySurbs?

optional dataReplySurbs: number

Source

sdk/typescript/packages/mix-tunnel/src/types.ts:17

primaryDns?

optional primaryDns: string

Source

sdk/typescript/packages/mix-tunnel/src/types.ts:18

fallbackDns?

optional fallbackDns: string

Source

sdk/typescript/packages/mix-tunnel/src/types.ts:19

storagePassphrase?

optional storagePassphrase: string

Source

sdk/typescript/packages/mix-tunnel/src/types.ts:20

connectTimeoutMs?

optional connectTimeoutMs: number

Source

sdk/typescript/packages/mix-tunnel/src/types.ts:21

dnsTimeoutMs?

optional dnsTimeoutMs: number

Source

sdk/typescript/packages/mix-tunnel/src/types.ts:22

tcpKeepaliveMs?

optional tcpKeepaliveMs: number

Source

sdk/typescript/packages/mix-tunnel/src/types.ts:23

tcpBufferSize?

optional tcpBufferSize: number

Source

sdk/typescript/packages/mix-tunnel/src/types.ts:24

maxRedirects?

optional maxRedirects: number

Source

sdk/typescript/packages/mix-tunnel/src/types.ts:25

debug?

optional debug: boolean

Source

sdk/typescript/packages/mix-tunnel/src/types.ts:26