API reference / @evolu/common / Evolu/Public
Evolu/Public
đź’ľ
Namespaces
| Namespace | Description |
|---|---|
| kysely | - |
Interfaces
| Interface | Description |
|---|---|
| AuthenticationPrompt | Configuration for the biometric/device credential prompt shown when a protected item is accessed. |
| AuthList | - |
| AuthResult | - |
| LocalAuth | Local authentication and authorization system for Evolu. This is API is subject to change and not recommended for production use. |
| LocalAuthDep | - |
| LocalAuthOptions | - |
| LocalAuthOptionsValues | - |
| MutationResult | - |
| SecureStorage | - **⚠️ |
| SecureStorageDep | - |
| SensitiveInfoGetRequest | - |
| SensitiveInfoItem | - |
| StorageMetadata | - |
Type Aliases
| Type Alias | Description |
|---|---|
| AccessControl | Enumerates the access-control policy enforced by the underlying secure storage. |
| SecurityLevel | Enumerates the highest security tier that was effectively applied while storing a value. |
| StorageBackend | Enumerates the native storage backend used to persist sensitive data. |
Variables
| Variable | Description |
|---|---|
| AUTH_DEFAULT_OPTIONS | - |
| AUTH_METAKEY_LAST_OWNER | - |
| AUTH_METAKEY_OWNER_NAMES | - |
| AUTH_NAMESPACE | - |
Functions
| Function | Description |
|---|---|
| createLocalAuth | Creates a local auth using the given secure storage implementation. This factory function allows each platform to provide its own storage layer while sharing the common auth logic. |
AppOwner
Re-exports AppOwner
createAppOwner
Re-exports createAppOwner
createEvolu
Re-exports createEvolu
createOwner
Re-exports createOwner
createOwnerSecret
Re-exports createOwnerSecret
createOwnerWriteKey
Re-exports createOwnerWriteKey
createShardOwner
Re-exports createShardOwner
createSharedOwner
Re-exports createSharedOwner
createSharedReadonlyOwner
Re-exports createSharedReadonlyOwner
createWebSocketTransportConfig
Re-exports createWebSocketTransportConfig
deriveShardOwner
Re-exports deriveShardOwner
Evolu
Re-exports Evolu
EvoluConfig
Re-exports EvoluConfig
EvoluDeps
Re-exports EvoluDeps
EvoluError
Re-exports EvoluError
EvoluSchema
Re-exports EvoluSchema
InferRow
Re-exports InferRow
mnemonicToOwnerSecret
Re-exports mnemonicToOwnerSecret
NetworkError
Re-exports NetworkError
Owner
Re-exports Owner
OwnerEncryptionKey
Re-exports OwnerEncryptionKey
OwnerId
Re-exports OwnerId
OwnerIdBytes
Re-exports OwnerIdBytes
ownerIdBytesToOwnerId
Re-exports ownerIdBytesToOwnerId
ownerIdToOwnerIdBytes
Re-exports ownerIdToOwnerIdBytes
OwnerSecret
Re-exports OwnerSecret
ownerSecretToMnemonic
Re-exports ownerSecretToMnemonic
OwnerWriteKey
Re-exports OwnerWriteKey
ownerWriteKeyLength
Re-exports ownerWriteKeyLength
parseOwnerIdFromUrl
Re-exports parseOwnerIdFromUrl
PaymentRequiredError
Re-exports PaymentRequiredError
Query
Re-exports Query
QueryRows
Re-exports QueryRows
Row
Re-exports Row
ServerError
Re-exports ServerError
ShardOwner
Re-exports ShardOwner
SharedOwner
Re-exports SharedOwner
SharedReadonlyOwner
Re-exports SharedReadonlyOwner
SyncOwner
Re-exports SyncOwner
SyncState
Re-exports SyncState
SyncStateInitial
Re-exports SyncStateInitial
SyncStateIsNotSynced
Re-exports SyncStateIsNotSynced
SyncStateIsSynced
Re-exports SyncStateIsSynced
SyncStateIsSyncing
Re-exports SyncStateIsSyncing
Timestamp
Re-exports Timestamp
TimestampBytes
Re-exports TimestampBytes
timestampBytesToTimestamp
Re-exports timestampBytesToTimestamp
TimestampCounterOverflowError
Re-exports TimestampCounterOverflowError
TimestampDriftError
Re-exports TimestampDriftError
TimestampError
Re-exports TimestampError
TimestampTimeOutOfRangeError
Re-exports TimestampTimeOutOfRangeError
timestampToTimestampBytes
Re-exports timestampToTimestampBytes
TransportConfig
Re-exports TransportConfig
WebSocketTransportConfig
Re-exports WebSocketTransportConfig