Skip to main content
Version: v2.0

Interface

This interface is used to set the options for the XP Client.

PropertyTypeOptionalDefaultDescription
auto_createbooleanβœ…Whether to auto create the user in the database.
dbOptions.type"mongodb" or "sqlite"βœ…mongodbThe type of database to use.
dbOptions.databaseMongoClient or better-sqlite3 databaseβœ…The database to use (REQUIRED IF TYPE SPECIFIED).
dbOptions.namestringβœ…MONGODB: Optional explicit database name. If omitted, default DB from the connection is used.
debugbooleanβœ…falseWhether to enable debug logging or not.
notifybooleanβœ…trueWhether to enable info logging or not.
xp_rate"fast", "normal", "slow" or numberβœ…normalThe rate of XP gain. Numeric values must be finite and greater than 0.