Skip to main content

Interface: ConnectOptions

Defined in: packages/client/src/bridge/transport.ts:107

Properties​

onUnreached?​

optional onUnreached?: () => void

Defined in: packages/client/src/bridge/transport.ts:118

Called when Leuria hasn't answered within reachMs; the attempt then goes on in the background (the app may still be starting, or be installed meanwhile) until timeoutMs. Without it, connect() rejects with LeuriaNotRunningError at reachMs.

Returns​

void

optional openLink?: false | ((url) => void)

Defined in: packages/client/src/bridge/transport.ts:126

Hand the leuria://connect link to the system, which opens the Leuria app (and starts it if needed). Default: follow the link in this page; false opens nothing (tests, or a CLI engine that asks by itself).

reachMs?​

optional reachMs?: number

Defined in: packages/client/src/bridge/transport.ts:111

Leuria must answer within this long, or it isn't running (or installed). Default 4 s.

signal?​

optional signal?: AbortSignal

Defined in: packages/client/src/bridge/transport.ts:120

Stop waiting (a newer attempt replaces this one).

timeoutMs?​

optional timeoutMs?: number

Defined in: packages/client/src/bridge/transport.ts:109

Give up waiting for the visitor's answer after this long. Default 5 minutes.