TryGhost/Ghost
1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-11-11 18:35:22 +03:00
Code Issues Projects Releases Wiki Activity

Fixed JSDoc for DB helper functions

Browse Source 
no issue

- the docs were referring to different parameter names so this commit
  bring them in line to make the warnings go away
This commit is contained in:
Daniel Lockyer 2021-06-11 16:03:42 +01:00
parent aee829db15
commit e3ea40e268
No known key found for this signature in database
GPG Key ID: D21186F0B47295AD
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
core/server/data/schema/commands.js
View File

@ -121,9 +121,9 @@ async function dropUnique(tableName, columns, transaction) {
* Checks if a foreign key exists in a table over the given columns.
*
* @param {Object} configuration - contains all configuration for this function
* @param {string} configuration.fromTableName - name of the table to add the foreign key to
* @param {string} configuration.fromTable - name of the table to add the foreign key to
* @param {string} configuration.fromColumn - column of the table to add the foreign key to
* @param {string} configuration.toTableName - name of the table to point the foreign key to
* @param {string} configuration.toTable - name of the table to point the foreign key to
* @param {string} configuration.toColumn - column of the table to point the foreign key to
* @param {import('knex')} configuration.transaction - connection object containing knex reference
*/
@ -146,9 +146,9 @@ async function hasForeignSQLite({fromTable, fromColumn, toTable, toColumn, trans
* Adds a foreign key to a table.
*
* @param {Object} configuration - contains all configuration for this function
* @param {string} configuration.fromTableName - name of the table to add the foreign key to
* @param {string} configuration.fromTable - name of the table to add the foreign key to
* @param {string} configuration.fromColumn - column of the table to add the foreign key to
* @param {string} configuration.toTableName - name of the table to point the foreign key to
* @param {string} configuration.toTable - name of the table to point the foreign key to
* @param {string} configuration.toColumn - column of the table to point the foreign key to
* @param {Boolean} configuration.cascadeDelete - adds the "on delete cascade" option if true
* @param {import('knex')} configuration.transaction - connection object containing knex reference
@ -200,9 +200,9 @@ async function addForeign({fromTable, fromColumn, toTable, toColumn, cascadeDele
* Drops a foreign key from a table.
*
* @param {Object} configuration - contains all configuration for this function
* @param {string} configuration.fromTableName - name of the table to add the foreign key to
* @param {string} configuration.fromTable - name of the table to add the foreign key to
* @param {string} configuration.fromColumn - column of the table to add the foreign key to
* @param {string} configuration.toTableName - name of the table to point the foreign key to
* @param {string} configuration.toTable - name of the table to point the foreign key to
* @param {string} configuration.toColumn - column of the table to point the foreign key to
* @param {import('knex')} configuration.transaction - connection object containing knex reference
*/