add type annotations in sample migrations

seppevs · Jan 29, 2025 · 55f8c0b · 55f8c0b
1 parent b08b924
commit 55f8c0b
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/samples/commonjs/migration.js b/samples/commonjs/migration.js
@@ -1,11 +1,21 @@
 module.exports = {
+  /**
+   * @param db {import('mongodb').Db}
+   * @param client {import('mongodb').MongoClient}
+   * @returns {Promise<void>}
+   */
   async up(db, client) {
     // TODO write your migration here.
     // See https://github.com/seppevs/migrate-mongo/#creating-a-new-migration-script
     // Example:
     // await db.collection('albums').updateOne({artist: 'The Beatles'}, {$set: {blacklisted: true}});
   },
 
+  /**
+   * @param db {import('mongodb').Db}
+   * @param client {import('mongodb').MongoClient}
+   * @returns {Promise<void>}
+   */
   async down(db, client) {
     // TODO write the statements to rollback your migration (if possible)
     // Example:

diff --git a/samples/esm/migration.js b/samples/esm/migration.js
@@ -1,10 +1,20 @@
+/**
+ * @param db {import('mongodb').Db}
+ * @param client {import('mongodb').MongoClient}
+ * @returns {Promise<void>}
+ */
 export const up = async (db, client) => {
     // TODO write your migration here.
     // See https://github.com/seppevs/migrate-mongo/#creating-a-new-migration-script
     // Example:
     // await db.collection('albums').updateOne({artist: 'The Beatles'}, {$set: {blacklisted: true}});
 };
 
+/**
+ * @param db {import('mongodb').Db}
+ * @param client {import('mongodb').MongoClient}
+ * @returns {Promise<void>}
+ */
 export const down = async (db, client) => {
     // TODO write the statements to rollback your migration (if possible)
     // Example: