API reference / @evolu/common / Evolu/Public / LocalAuth
Interface: LocalAuth
Defined in: packages/common/src/Evolu/LocalAuth.ts:19
Experimental
Local authentication and authorization system for Evolu. This is API is subject to change and not recommended for production use.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
clearAll | (options?) => Promise<void> | Experimental Clears all owners and metadata from the local auth. | packages/common/src/Evolu/LocalAuth.ts:42 |
getOwner | (options?) => Promise< | AuthResult | null> | Experimental Gets the current owner (last logged in or last registered owner) | packages/common/src/Evolu/LocalAuth.ts:36 |
getProfiles | (options?) => Promise<AuthList[]> | Experimental Lists all registered owner ids with associated usernames. | packages/common/src/Evolu/LocalAuth.ts:39 |
login | (ownerId, options?) => Promise< | AuthResult | null> | Experimental Logs in with the given owner ID, or loads the target owner if not provided. | packages/common/src/Evolu/LocalAuth.ts:21 |
register | (username, options?) => Promise< | AuthResult | null> | Experimental Registers a new owner with the given username. | packages/common/src/Evolu/LocalAuth.ts:27 |
unregister | (ownerId, options?) => Promise<void> | Experimental Unregisters an owner with the given owner ID. | packages/common/src/Evolu/LocalAuth.ts:33 |