connect.proxy

Control the profile's proxy arbiter. Connect+-only.

• Capability: proxy
• Namespace: connect.proxy

Walkthrough

Route the profile through a proxy.

1. Declare proxy:

   { "capabilities": ["proxy"] }

2. Enable it with a valid URL:

   await connect.proxy.set({ enabled: true, url: 'http://127.0.0.1:8080' });

3. Disable it (which clears the URL):

   await connect.proxy.set({ enabled: false });

Methods

proxy.get()

Read the current proxy setting.

How to use it

1. Call it to read { enabled, url }.

Signature — connect.proxy.get() · Capability: proxy · Returns — Promise<{ enabled, url }>.

proxy.set(options)

Set the proxy.

How to use it

1. To enable, pass { enabled: true, url } — a valid url is required.
2. To disable, pass { enabled: false } — the URL is cleared.

Signature — connect.proxy.set({ enabled, url? })

Parameters

Returns — Promise<void>.

await connect.proxy.set({ enabled: true, url: 'http://127.0.0.1:8080' });
await connect.proxy.set({ enabled: false }); // clears the url

Notes

• The proxy applies to the whole profile. Read the current state (including whether it's on) from connect.profile too (proxyEnabled).