API Overview

All public exports from mevn-orm.

import {
  Model,
  ModelCollection,
  HasOneRelation,
  HasManyRelation,
  BelongsToRelation,
  Relation,
  configureDatabase,
  createKnexConfig,
  configure,
  getDB,
  DB,
  setMigrationConfig,
  getMigrationConfig,
  makeMigration,
  migrateLatest,
  migrateRollback,
  migrateCurrentVersion,
  migrateList,
  getTableName,
  toSnakeCase,
} from 'mevn-orm'

import type { PaginatedResult } from 'mevn-orm'

Models & collections

Export	Description
Model	ActiveRecord base class
ModelCollection	Array subclass from all() / paginate().data with toArray()
PaginatedResult	Type for pagination results

Configuration

Export	Description
configureDatabase	Initialise from simple options (recommended)
createKnexConfig	Build Knex config without initialising
configure	Initialise from Knex config or instance
getDB	Active Knex instance (throws if unconfigured)
DB	Knex instance export (available after configure)

Relationships

Export	Description
HasOneRelation	One-to-one lazy relation
HasManyRelation	One-to-many lazy relation
BelongsToRelation	Belongs-to lazy relation
Relation	Abstract base (Promise-like)

Migrations

Export	Description
setMigrationConfig	Default migrator options
getMigrationConfig	Read defaults
makeMigration	Generate a migration file
migrateLatest	Run pending migrations
migrateRollback	Roll back batch(es)
migrateCurrentVersion	Current version string
migrateList	Completed and pending filenames

Helpers

Export	Description
getTableName	Pluralised snake_case table name from a class name
toSnakeCase	PascalCase / camelCase → snake_case

Guides

For narrative tutorials and end-to-end examples, start with the Getting Started guide.