@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:101 (opens in a new tab)

disconnectMixTunnel()

disconnectMixTunnel(): Promise<void>

Returns

Promise<void>

Source

sdk/typescript/packages/mix-tunnel/src/types.ts:102 (opens in a new tab)

getTunnelState()

getTunnelState(): Promise<TunnelState>

Returns

Promise<TunnelState>

Source

sdk/typescript/packages/mix-tunnel/src/types.ts:103 (opens in a new tab)

mixFetch()

mixFetch(url, init): Promise<MixFetchResponseInit>

Parameters

• url: string

• init: unknown

Returns

Promise<MixFetchResponseInit>

Source

sdk/typescript/packages/mix-tunnel/src/types.ts:104 (opens in a new tab)

mixDNS()

mixDNS(hostname): Promise<string>

Parameters

• hostname: string

Returns

Promise<string>

Source

sdk/typescript/packages/mix-tunnel/src/types.ts:105 (opens in a new tab)

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:106 (opens in a new tab)

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:107 (opens in a new tab)

wsClose()

wsClose(handleId, code, reason): Promise<void>

Parameters

• handleId: number

• code: number

• reason: string

Returns

Promise<void>

Source

sdk/typescript/packages/mix-tunnel/src/types.ts:108 (opens in a new tab)