ApiSessionInterfaces
Interface: MincaAuthConfig
Defined in: packages/core/src/session/auth.ts:99
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
appName? | readonly | string | What passkey prompts call this app. Default "Minca". | packages/core/src/session/auth.ts:101 |
browser? | readonly | object | Accounts kept in this browser, and their data. Defaults to IndexedDB; swap both for tests or for a host with no IndexedDB. | packages/core/src/session/auth.ts:120 |
browser.accounts | readonly | () => Promise<AccountStore> | - | packages/core/src/session/auth.ts:121 |
browser.stores | readonly | (account) => StoreFactory | - | packages/core/src/session/auth.ts:122 |
network? | readonly | NodeNetworkConfig | Relays, always-on nodes and hosts the signed-in node connects to. Omit to stay offline. | packages/core/src/session/auth.ts:103 |
offerPod? | readonly | boolean | Whether a new account is offered a pod before it goes in (pod). Default true. Turn it off where the page closes once signed in, as when an app opened it to connect: the pod is only kept up to date while this page runs, so it is better offered where the person comes back. | packages/core/src/session/auth.ts:137 |
pairingLink? | readonly | string | The page a phone-pairing QR opens. Default: this page. | packages/core/src/session/auth.ts:111 |
pairingTransport? | readonly | (did) => PeerTransport | How the two sides of a pairing reach each other, given a throwaway DID. Default: the relay. For tests, or a host with its own. | packages/core/src/session/auth.ts:113 |
rpId? | readonly | string | The site passkeys belong to. Default: this page's hostname. | packages/core/src/session/auth.ts:105 |
signOutGraceMs? | readonly | number | How long signing out waits, at most, for a peer to take its revokes in. Default 5 s. | packages/core/src/session/auth.ts:115 |
storage? | readonly | KeyValueStore | null | Where small choices are remembered — which account, stay signed in. Default localStorage. | packages/core/src/session/auth.ts:107 |
storageKey? | readonly | string | Namespaces those choices, so two apps on one origin keep their own. Default "minca". | packages/core/src/session/auth.ts:109 |
usernames? | readonly | string | Where a new account takes its username, as minca.social: creating one offers <name>@<this>, claimed in the background (packages/core/docs/usernames.md). Default: none offered. | packages/core/src/session/auth.ts:143 |
worker? | readonly | () => WorkerLike | Runs the node in a worker, off the page's main thread (@minca/core/node-worker). Called once per sign-in; the worker ends when the node closes. Not with browser.stores, which a worker can't be handed. Default: the node runs on the page. | packages/core/src/session/auth.ts:130 |