mirror of
https://github.com/TryGhost/Ghost.git
synced 2025-02-03 23:00:14 -05:00
Fixed minor jsdoc typing issue regarding arrays
- `[string]` indicates an array with exactly one item but we actually want the type to be `string[]` to indicate an array of strings
This commit is contained in:
parent
b3ee6a4c9e
commit
2422f4a95c
2 changed files with 4 additions and 4 deletions
|
@ -126,7 +126,7 @@ async function dropColumn(tableName, column, transaction = db.knex, columnSpec =
|
|||
* Adds an unique index to a table over the given columns.
|
||||
*
|
||||
* @param {string} tableName - name of the table to add unique constraint to
|
||||
* @param {string|[string]} columns - column(s) to form unique constraint with
|
||||
* @param {string|string[]} columns - column(s) to form unique constraint with
|
||||
* @param {import('knex')} transaction - connection object containing knex reference
|
||||
*/
|
||||
async function addUnique(tableName, columns, transaction = db.knex) {
|
||||
|
@ -153,7 +153,7 @@ async function addUnique(tableName, columns, transaction = db.knex) {
|
|||
* Drops a unique key constraint from a table.
|
||||
*
|
||||
* @param {string} tableName - name of the table to drop unique constraint from
|
||||
* @param {string|[string]} columns - column(s) unique constraint was formed
|
||||
* @param {string|string[]} columns - column(s) unique constraint was formed
|
||||
* @param {import('knex')} transaction - connection object containing knex reference
|
||||
*/
|
||||
async function dropUnique(tableName, columns, transaction = db.knex) {
|
||||
|
@ -327,7 +327,7 @@ async function hasPrimaryKeySQLite(tableName, transaction = db.knex) {
|
|||
* Adds an primary key index to a table over the given columns.
|
||||
*
|
||||
* @param {string} tableName - name of the table to add primaykey constraint to
|
||||
* @param {string|[string]} columns - column(s) to form primary key constraint with
|
||||
* @param {string|string[]} columns - column(s) to form primary key constraint with
|
||||
* @param {import('knex')} transaction - connection object containing knex reference
|
||||
*/
|
||||
async function addPrimaryKey(tableName, columns, transaction = db.knex) {
|
||||
|
|
|
@ -208,7 +208,7 @@ module.exports = {
|
|||
|
||||
/**
|
||||
* @param {Email-like} emailData - The email to send, must be a POJO so emailModel.toJSON() before calling if needed
|
||||
* @param {[EmailRecipient]} recipients - The recipients to send the email to with their associated data
|
||||
* @param {EmailRecipient[]} recipients - The recipients to send the email to with their associated data
|
||||
* @param {string?} memberSegment - The member segment of the recipients
|
||||
* @returns {Promise<Object>} - {providerId: 'xxx'}
|
||||
*/
|
||||
|
|
Loading…
Add table
Reference in a new issue