π Welcome!
Welcome to the documentation of simply-xp. This documentation will help you get started with simply-xp.
Documentation made for:
v2.0.0Installationβ
- NPM
- PNPM
- YARN
npm install simply-xp@2.0.0
pnpm install simply-xp@2.0.0
yarn add simply-xp@2.0.0
Pick a database adapter
simply-xp ships without a database driver. Install one alongside it β mongodb for MongoDB, or better-sqlite3 for SQLite:
npm install mongodb
# or
npm install better-sqlite3
If you call connect() without the matching adapter installed, simply-xp throws a catchable SimplyXpFatal with error.code === "SX_ADAPTER_MISSING", and the message tells you exactly what to install.
simply-xp itself supports Node.js 14+, but the adapters require newer runtimes. If your Node.js version is older than the adapter's requirement, install an adapter major that matches it (for example better-sqlite3@11 or mongodb@6) instead of the latest.
β Importing simply-xpβ
- JavaScript
- TypeScript
const simplyxp = require("simply-xp");
import * as simplyxp from "simply-xp";
π Useful Pagesβ
Migration Support- Migrate from other libraries to simply-xp.Breaking Changes- Changes from v1 to v2.Support Server- Join our support server for help.