Mongoat

Appearance

@iamcalegari/mongoat / defineConfig

Function: defineConfig() ​

defineConfig(config): MongoatMigrationsConfig

Defined in: src/migrate/index.ts:77

Identity helper for authoring a mongoat.config.{json,js,ts} file — takes the migrations config knobs and returns them unchanged, giving the author full type inference on MongoatMigrationsConfig without an explicit annotation on the exported object. A plain object literal works the same way without this helper — it exists purely for type-checking and autocomplete, never as a runtime requirement (a .json config has no code to call it from).

The exported config must stay a static, side-effect-free object: when the CLI re-executes itself under a TypeScript-capable runtime, the config module is evaluated once in the original process and again in the re-executed child — up to TWICE per invocation, the second time under a different runtime. A top-level side effect (reading a .env, resolving a secret, opening a socket) would therefore run twice; keep the module idempotent, or side-effect-free entirely.

Parameters ​

config ​

MongoatMigrationsConfig

The migrations config knobs (all optional).

Returns ​

MongoatMigrationsConfig

The same config, unchanged.

Example ​

typescript
import { defineConfig } from '@iamcalegari/mongoat';

export default defineConfig({
  dir: 'db/migrations',
});