fix(types): add getForeignKeyReferencesForTable type (#11738)

sequelize · Dec 12, 2019 · 819e9dd · 819e9dd
1 parent eccf973
commit 819e9dd
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/lib/query-interface.js b/lib/query-interface.js
@@ -673,6 +673,15 @@ class QueryInterface {
     return this.sequelize.query(sql, Object.assign({}, options, { type: QueryTypes.SHOWINDEXES }));
   }
 
+
+  /**
+   * Returns all foreign key constraints of a table
+   *
+   * @param {string[]} tableNames table names
+   * @param {Object} [options] Query options
+   * 
+   * @returns {Promise}
+   */
   getForeignKeysForTables(tableNames, options) {
     if (tableNames.length === 0) {
       return Promise.resolve({});

diff --git a/types/lib/query-interface.d.ts b/types/lib/query-interface.d.ts
@@ -442,6 +442,11 @@ export class QueryInterface {
    */
   public getForeignKeysForTables(tableNames: string, options?: QueryInterfaceOptions): Promise<object>;
 
+  /**
+   * Get foreign key references details for the table
+   */
+  public getForeignKeyReferencesForTable(tableName: string, options?: QueryInterfaceOptions): Promise<object>;
+
   /**
    * Inserts a new record
    */