API reference / @evolu/common / Evolu/Internal / EvoluConfigWithFunctions
Interface: EvoluConfigWithFunctions
Defined in: packages/common/src/Evolu/Evolu.ts:468
Extends
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
enableLogging? | readonly | boolean | Enable or disable console logging (default: false). When true, logs are output to the Console; when false, logging is disabled for all methods except error, which always outputs to ensure critical issues are not missed. | Config.enableLogging | packages/common/src/Console.ts:91 |
indexes? | readonly | DbIndexesBuilder | Use the indexes option to define SQLite indexes. Table and column names are not typed because Kysely doesn't support it. https://medium.com/@JasonWyatt/squeezing-performance-from-sqlite-indexes-indexes-c4e175f3c346 ### Example const evolu = createEvolu(evoluReactDeps)(Schema, { indexes: (create) => [ create("todoCreatedAt").on("todo").column("createdAt"), create("todoCategoryCreatedAt") .on("todoCategory") .column("createdAt"), ], }); | Config.indexes | packages/common/src/Evolu/Config.ts:67 |
initialAppOwner? | readonly | AppOwner | Initial AppOwner to use when creating Evolu instance. If omitted, a new AppOwner will be generated automatically. | Config.initialAppOwner | packages/common/src/Evolu/Config.ts:73 |
inMemory? | readonly | boolean | Use in-memory SQLite database instead of persistent storage. Useful for testing or temporary data that doesn't need persistence. In-memory databases exist only in RAM and are completely destroyed when the process ends, making them forensically safe for sensitive data. The default value is: false. | Config.inMemory | packages/common/src/Evolu/Config.ts:84 |
maxDrift | readonly | number | Maximum physical clock drift allowed in ms. The default value is 5 * 60 * 1000 (5 minutes). | Config.maxDrift | packages/common/src/Evolu/Config.ts:45 |
name | readonly | string & Brand<"SimpleName"> | The name of the Evolu instance. Evolu is multitenant - it can run multiple instances concurrently. Each instance must have a unique name. The instance name is used as the SQLite database filename for persistent storage, ensuring that database files are separated and invisible to each other. The default value is: Evolu. ### Example // name: getOrThrow(SimpleName.from("MyApp")) | Config.name | packages/common/src/Evolu/Config.ts:24 |
onInit? | readonly | (params) => void | Callback invoked when the database is initialized. Use isFirst to perform one-time setup like initial data seeding. ### Example const evolu = createEvolu(evoluReactWebDeps)(Schema, { onInit: ({ appOwner, isFirst }) => { if (isFirst) { const todoCategoryId = getOrThrow( evolu.insert("todoCategory", { name: "Not Urgent", }), ); evolu.insert("todo", { title: "Try React Suspense", categoryId: todoCategoryId.id, }); } }, }); | - | packages/common/src/Evolu/Evolu.ts:494 |
reloadUrl | readonly | string | URL to reload browser tabs after reset or restore. The default value is /. | Config.reloadUrl | packages/common/src/Evolu/Config.ts:38 |
syncUrl | readonly | string | URL for Evolu sync and backup server. The default value is wss://free.evoluhq.com. | Config.syncUrl | packages/common/src/Evolu/Config.ts:31 |