@jsgurucompany/jsg-nestjs-common/lib/database/type/migrator.interface.d.ts

Initial README.md

import { QueryInterface } from 'sequelize';
import { SequelizeStorage } from 'umzug';
import { LoggerFn } from '../../logger';
import { IMigrationMeta } from './migration.interface';
import { MigrateDownOptions as UmzugMigrateDownOptions } from 'umzug/lib/types';
export declare type MigratorContext = QueryInterface;
export declare type MigrateDownOptions = UmzugMigrateDownOptions;
export interface IMigratorOptions {
    migrationsGlob: string;
    migrationsPath: string;
    context: MigratorContext;
    storage: SequelizeStorage;
    logger?: Record<'info' | 'warn' | 'error' | 'debug', LoggerFn>;
}
export interface ICreateMigrationOptions {
    name: string;
    folder?: string;
}
export interface IMigrator {
    up: () => Promise<IMigrationMeta[]>;
    down: (options?: MigrateDownOptions) => Promise<IMigrationMeta[]>;
    create: (options: ICreateMigrationOptions) => Promise<void>;
    getMigrationsPath: () => string;
    setMigrationsPath: (path: string) => void;
}