mfahampshire
7c890ea0c5
* 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
3.3 KiB
@nymproject/mix-tunnel • Docs
@nymproject/mix-tunnel / IMixTunnelWorker
Interface: IMixTunnelWorker
Methods
setupMixTunnel()
setupMixTunnel(
opts?):Promise<void>
Parameters
• opts?: SetupMixTunnelOpts
Returns
Promise<void>
Source
sdk/typescript/packages/mix-tunnel/src/types.ts:61
disconnectMixTunnel()
disconnectMixTunnel():
Promise<void>
Returns
Promise<void>
Source
sdk/typescript/packages/mix-tunnel/src/types.ts:62
getTunnelState()
getTunnelState():
Promise<TunnelState>
Returns
Promise<TunnelState>
Source
sdk/typescript/packages/mix-tunnel/src/types.ts:63
mixFetch()
mixFetch(
url,init):Promise<MixFetchResponseInit>
Parameters
• url: string
• init: unknown
Returns
Promise<MixFetchResponseInit>
Source
sdk/typescript/packages/mix-tunnel/src/types.ts:64
mixDNS()
mixDNS(
hostname):Promise<string>
Parameters
• hostname: string
Returns
Promise<string>
Source
sdk/typescript/packages/mix-tunnel/src/types.ts:65
mixWebSocket()
mixWebSocket(
url,protocols,onEvent):Promise<number>
Parameters
• url: string
• protocols: undefined | string[]
• onEvent: WsEventCallback
Returns
Promise<number>
Source
sdk/typescript/packages/mix-tunnel/src/types.ts:66
wsSend()
wsSend(
handleId,data):Promise<void>
Parameters
• handleId: number
• data: string | Uint8Array | ArrayBuffer
Returns
Promise<void>
Source
sdk/typescript/packages/mix-tunnel/src/types.ts:67
wsClose()
wsClose(
handleId,code,reason):Promise<void>
Parameters
• handleId: number
• code: number
• reason: string
Returns
Promise<void>