Interface
Runtime configuration and metadata that xp exposes throughout simply-xp.
| Property | Type | Optional | Default | Description |
|---|---|---|---|---|
| auto_clean | boolean | β | false | Automatically cleans caches or stale database entries after major operations. |
| auto_create | boolean | β | false | Allows helpers to create missing users when they are queried. |
| database | MongoClient or Database | β | undefined | Underlying database connection provided by the consumer. |
| dbType | "mongodb" | "sqlite" | β | mongodb | Configured database provider. |
| debug | boolean | β | false | Emit debug logging via XpLog.debug. |
| notify | boolean | β | true | Enable console notifications (on by default). |
| registeredFonts | Array<string> | β | [] | Fonts already registered for rendering helpers. |
| version | string | β | 2.0.0-beta.3 | simply-xp version string baked into the package. |
| xp_rate | number | β | 0.1 | Global XP rate used during XP βοΈ level conversions. |