Resolves #4583 Add JSDoc (TS flavor) to stub files (#4809)

knex · Nov 6, 2021 · 3aadaea · 3aadaea
1 parent 75ece73
commit 3aadaea
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/lib/migrations/migrate/stub/js.stub b/lib/migrations/migrate/stub/js.stub
@@ -1,4 +1,7 @@
-
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 exports.up = function(knex) {
   <% if (d.tableName) { %>
   return knex.schema.createTable("<%= d.tableName %>", function(t) {
@@ -8,6 +11,10 @@ exports.up = function(knex) {
   <% } %>
 };
 
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
 exports.down = function(knex) {
   <% if (d.tableName) { %>
   return knex.schema.dropTable("<%= d.tableName %>");

diff --git a/lib/migrations/migrate/stub/knexfile-js.stub b/lib/migrations/migrate/stub/knexfile-js.stub
@@ -1,5 +1,8 @@
 // Update with your config settings.
 
+/**
+ * @type { Object.<string, import("knex").Knex.Config> }
+ */
 module.exports = {
 
   development: {

diff --git a/lib/migrations/seed/stub/js.stub b/lib/migrations/seed/stub/js.stub
@@ -1,4 +1,7 @@
-
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> } 
+ */
 exports.seed = function(knex) {
   // Deletes ALL existing entries
   return knex('table_name').del()