ApiSessionFunctions
Function: connectCarrier()
function connectCarrier(options): Promise<CarryGrant>;Defined in: packages/core/src/session/connect.ts:400
Asks a home to use this carrier — a browser extension, say — for the account. Call it from a click, in a page that stays open until the answer comes: an extension's toolbar popup closes the moment the home's window takes focus, and the answer would have nowhere to go.
Parameters
| Parameter | Type | Description |
|---|---|---|
options | { home: string; key: AppKey; name?: string; timeoutMs?: number; } | - |
options.home | string | - |
options.key | AppKey | The carrier's own key; it becomes its name to peers |
options.name? | string | - |
options.timeoutMs? | number | - |
Returns
Promise<CarryGrant>
The grant, checked: an invite to a private carry space the account made