Configuration

Arkormˣ loads config from arkormx.config.cjs, arkormx.config.js, or arkormx.config.ts in your project root.

defineConfig

import { defineConfig } from 'arkormx';
import { PrismaClient } from '@prisma/client';

export default defineConfig({
  prisma: new PrismaClient(),
});

Full configuration shape

import { defineConfig, URLDriver } from 'arkormx';
import { PrismaClient } from '@prisma/client';

const prisma = new PrismaClient();

class AppURLDriver extends URLDriver {}

export default defineConfig({
  prisma: new PrismaClient(),
  pagination: {
    urlDriver: (options) => new AppURLDriver(options),
  },
  paths: {
    stubs: './stubs',
    models: './src/models',
    factories: './database/factories',
    seeders: './database/seeders',
    migrations: './database/migrations',
    buildOutput: './dist',
  },
  outputExt: 'ts',
});

Config reference

• prisma (required): Prisma client instance or resolver function.
• pagination.urlDriver: custom URL driver factory for paginator links.
• pagination.resolveCurrentPage: runtime hook used when paginate() or simplePaginate() is called without an explicit page argument.
• paths.models: generated model directory.
• paths.factories: generated factory directory.
• paths.seeders: generated seeder directory.
• paths.migrations: generated migration directory.
• paths.buildOutput: build output root used to map runtime files in production.
• outputExt: preferred generated extension ('ts' by default, falls back to 'js' when TypeScript is unavailable).

Runtime configuration

For frameworks that bootstrap Prisma elsewhere, use runtime configuration:

import { configureArkormRuntime } from 'arkormx';

configureArkormRuntime(() => prisma, {
  outputExt: 'js',
});

Runtime configuration also enables transaction scopes through Model.transaction(...), because Arkorm can resolve the active Prisma client and switch model queries onto the transaction client automatically.