README.md

yammy

yammy

Index

Classes

• Create
• Down
• Migrate
• Status
• Up

Interfaces

• ConfigFile
• DbOptions
• MigrateOptions
• MigrateOptionsDefaults
• Migration
• MigrationFile
• MigrationStatus

Type aliases

• MigrationFunction

Variables

• CONFIG_NAMES

Functions

• getConfig

Type aliases

MigrationFunction

Ƭ MigrationFunction: function

Defined in src/index.ts:40

Migration function.

param DB instance.

param MongoDB session, if passed it will use transaction.

Type declaration:

▸ (db: Db, session?: ClientSession): Promise‹void›

Parameters:

Name	Type
db	Db
session?	ClientSession

Variables

Const CONFIG_NAMES

• CONFIG_NAMES: string[] = [ '.yammyrc', '.yammyrc.json', '.yammyrc.js', '.migrationsrc', '.migrationsrc.json', '.migrationsrc.js', ]

Defined in src/cli-helpers.ts:4

Functions

getConfig

▸ getConfig(file?: undefined | string): ConfigFile | undefined

Defined in src/cli-helpers.ts:15

Parameters:

Name	Type
file?	undefined | string

Returns: ConfigFile | undefined