API reference › @evolu/common › local‑first/Evolu
Local-first platform.
Core
| Name | Description |
|---|---|
| Evolu | A local-first SQL database. |
| DevicePersistence | Whether this device keeps an Evolu database, stating only what Evolu knows for sure. |
| EvoluError | Represents app-level errors that can occur in Evolu. |
| UnuseOwner | Function returned by Evolu.useOwner to stop using an Owner for sync. |
| maxMutationSize | The largest Mutation, in bytes. |
Configuration
| Name | Description |
|---|---|
| AppNameError | Error produced when a value is not a valid AppName. |
| EvoluConfig | Configuration for createEvolu. |
| AppName | Application name. |
| AppName | Application name. |
Construction
| Name | Description |
|---|---|
| EvoluErrorDep | Dependency wrapper for the shared EvoluError store. |
| RequestPersistentStorageDep | Asks the platform to keep stored databases until the user deletes them. |
| SyncStateDep | Dependency wrapper for the shared SyncState store. |
| EvoluDeps | Shared platform dependencies for creating Evolu instances. |
| EvoluPlatformDeps | Platform-specific dependencies required to create EvoluDeps. |
| createEvolu | Creates an Evolu instance from EvoluSchema and EvoluConfig. |
| createEvoluDeps | Creates shared dependencies used by all createEvolu instances on a platform. |
Testing
| Variable | Description |
|---|---|
| testAppName | Stable valid AppName for tests and examples. |