Mirrors/audiobookshelf
1
0
Fork 0
mirror of https://github.com/advplyr/audiobookshelf.git synced 2026-03-13 02:19:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update migrations jsdocs

Browse Source
This commit is contained in:
advplyr
2024-09-10 15:57:07 -05:00
parent 6fb1202c1c
commit 7cbf9de8ca
2 changed files with 27 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
test/server/migrations/v0.0.1-migration_example.js
View File

@@ -1,10 +1,18 @@
const { DataTypes } = require('sequelize')
/**
* @typedef MigrationContext
* @property {import('sequelize').QueryInterface} queryInterface - a suquelize QueryInterface object.
* @property {import('../Logger')} logger - a Logger object.
*
* @typedef MigrationOptions
* @property {MigrationContext} context - an object containing the migration context.
*/
/**
* This is an example of an upward migration script.
*
* @param {import { QueryInterface } from "sequelize";} options.context.queryInterface - a suquelize QueryInterface object.
* @param {import { Logger } from "../../../server/Logger";} options.context.logger - a Logger object.
* @param {MigrationOptions} options - an object containing the migration context.
* @returns {Promise<void>} - A promise that resolves when the migration is complete.
*/
async function up({ context: { queryInterface, logger } }) {
@@ -28,8 +36,7 @@ async function up({ context: { queryInterface, logger } }) {
/**
* This is an example of a downward migration script.
*
* @param {import { QueryInterface } from "sequelize";} options.context.queryInterface - a suquelize QueryInterface object.
* @param {import { Logger } from "../../../server/Logger";} options.context.logger - a Logger object.
* @param {MigrationOptions} options - an object containing the migration context.
* @returns {Promise<void>} - A promise that resolves when the migration is complete.
*/
async function down({ context: { queryInterface, logger } }) {