Skip to main content

Installation

Install Hysteria ORM using your preferred package manager:

yarn add hysteria-orm
# or
npm install --save hysteria-orm

Peer Dependencies

  • Make sure you have the correct database driver installed for your target database:
    • PostgreSQL: pg
    • MySQL/MariaDB: mysql2
    • SQLite: sqlite3
    • MongoDB: mongodb
    • Redis: ioredis

Example:

npm install pg mysql2 sqlite3 mongodb ioredis

Quick Verification

After installation, you can verify by importing the package in a TypeScript or JavaScript file:

import { sql, mongo, redis } from 'hysteria-orm';

Next: Setup