@types/db-migrate-base - npm Package Compare versions

Comparing version 0.0.7 to 0.0.8

db-migrate-base/index.d.ts

@@ -11,100 +11,102 @@ // Type definitions for db-migrate-base
 
-export interface CallbackFunction { (err: any, response: any): void; }
+declare namespace Base {
+    interface CallbackFunction { (err: any, response: any): void; }
 
-export interface InternalModule {
-  log: any;
-  type: any;
-}
+    interface InternalModule {
+        log: any;
+        type: any;
+    }
 
-export interface InternalOptions {
-  mod: InternalModule;
-}
+    interface InternalOptions {
+        mod: InternalModule;
+    }
 
-export interface ColumnSpec {
-  length?: number;
-  type: string;
-  unsigned?: boolean;
-  primaryKey?: boolean;
-  autoIncrement?: boolean;
-  notNull?: boolean;
-  unique?: boolean;
-  defaultValue?: any;
-  foreignKey?: ForeignKeySpec;
-}
+    interface ColumnSpec {
+        length?: number;
+        type: string;
+        unsigned?: boolean;
+        primaryKey?: boolean;
+        autoIncrement?: boolean;
+        notNull?: boolean;
+        unique?: boolean;
+        defaultValue?: any;
+        foreignKey?: ForeignKeySpec;
+    }
 
-export interface ForeignKeySpec {
-  name: string;
-  table: string;
-  rules?: ForeignKeyRules;
-  mapping: string | any;
-}
+    interface ForeignKeySpec {
+        name: string;
+        table: string;
+        rules?: ForeignKeyRules;
+        mapping: string | any;
+    }
 
-export interface ForeignKeyRules {
-  onDelete: string;
-  onUpdate: string;
-}
+    interface ForeignKeyRules {
+        onDelete: string;
+        onUpdate: string;
+    }
 
-export interface RemoveForeignKeyOptions {
-  dropIndex?: boolean;
-}
+    interface RemoveForeignKeyOptions {
+        dropIndex?: boolean;
+    }
 
-export interface ColumnDef {
-  foreignKey?: any; // TODO Figure this out!
-  constraints: string;
-}
+    interface ColumnDef {
+        foreignKey?: any; // TODO Figure this out!
+        constraints: string;
+    }
 
-export interface CreateTableOptions {
-  columns?: Array<ColumnSpec>;
-  ifNotExists?: boolean;
-}
+    interface CreateTableOptions {
+        columns?: Array<ColumnSpec>;
+        ifNotExists?: boolean;
+    }
 
-export interface DropTableOptions {
-  ifExists?: boolean;
+    interface DropTableOptions {
+        ifExists?: boolean;
+    }
 }
 
-export class Base {
-  constructor(intern: InternalOptions);
+declare class Base {
+  constructor(intern: Base.InternalOptions);
 
-  close(callback?: CallbackFunction): void;
+  close(callback?: Base.CallbackFunction): void;
   mapDataType(str: string): string;
-  truncate(tableName: string, callback: CallbackFunction): void;
-  checkDBMS(dbms: any, callback: CallbackFunction): void;
+  truncate(tableName: string, callback: Base.CallbackFunction): void;
+  checkDBMS(dbms: any, callback: Base.CallbackFunction): void;
   createDatabase(...options: any[]): void;
   switchDatabase(...options: any[]): void;
   dropDatabase(...options: any[]): void;
-  recurseCallbackArray(foreignKeys: Array<string>, callback: CallbackFunction): void;
-  bindForeignKey(tableName: string, columnName: string, fkOptions: ForeignKeySpec): (callback: CallbackFunction) => void;
-  createColumnDef(name: string, spec: ColumnSpec, options?: any): ColumnDef;  // TODO Figure out a type for `options`!
-  //createColumnConstraint(spec: ColumnSpec, options?: any, ...implementationDefinedOptions: any[]): string;
-  createMigrationsTable(callback: CallbackFunction): void;
-  createSeedsTable(callback: CallbackFunction): void;
-  createTable(tableName: string, options: any | CreateTableOptions, callback: CallbackFunction): void;
-  dropTable(tableName: string, optionsOrCb?: DropTableOptions | CallbackFunction, callback?: CallbackFunction): void;
-  renameTable(tableName: string, newTableName: string, callback: CallbackFunction): void;
-  addColumn(tableName: string, columnName: string, columnSpec: ColumnSpec, callback: CallbackFunction): void;
-  removeColumn(tableName: string, columnName: string, callback: CallbackFunction): void;
-  renameColumn(tableName: string, oldColumnName: string, newColumnName: string, callback: CallbackFunction): void;
-  changeColumn(tableName: string, columnName: string, columnSpec: ColumnSpec, callback: CallbackFunction): void;
+  recurseCallbackArray(foreignKeys: Array<string>, callback: Base.CallbackFunction): void;
+  bindForeignKey(tableName: string, columnName: string, fkOptions: Base.ForeignKeySpec): (callback: Base.CallbackFunction) => void;
+  createColumnDef(name: string, spec: Base.ColumnSpec, options?: any): Base.ColumnDef;  // TODO Figure out a type for `options`!
+  //createColumnConstraint(spec: Base.ColumnSpec, options?: any, ...implementationDefinedOptions: any[]): string;
+  createMigrationsTable(callback: Base.CallbackFunction): void;
+  createSeedsTable(callback: Base.CallbackFunction): void;
+  createTable(tableName: string, options: any | Base.CreateTableOptions, callback: Base.CallbackFunction): void;
+  dropTable(tableName: string, optionsOrCb?: Base.DropTableOptions | Base.CallbackFunction, callback?: Base.CallbackFunction): void;
+  renameTable(tableName: string, newTableName: string, callback: Base.CallbackFunction): void;
+  addColumn(tableName: string, columnName: string, columnSpec: Base.ColumnSpec, callback: Base.CallbackFunction): void;
+  removeColumn(tableName: string, columnName: string, callback: Base.CallbackFunction): void;
+  renameColumn(tableName: string, oldColumnName: string, newColumnName: string, callback: Base.CallbackFunction): void;
+  changeColumn(tableName: string, columnName: string, columnSpec: Base.ColumnSpec, callback: Base.CallbackFunction): void;
   quoteDDLArr(arr: Array<string>): Array<string>;
   quoteArr(arr: Array<string>): Array<string>;
-  addIndex(tableName: string, indexName: string, columns: string | Array<string>, uniqueOrCb?: boolean | CallbackFunction, callback?: CallbackFunction): void;
-  insert(tableName: string, columnNameOrValueArray: any, valueArrayOrCb?: any | CallbackFunction, callback?: CallbackFunction): void;
-  update(tableName: string, columnNameOrValueArray: any, valueArrayOrIds?: any, idsOrCb?: any | CallbackFunction, callback?: CallbackFunction): void;
-  lookup(tableName: string, column: string, id?: any, callback?: CallbackFunction): void;
-  removeIndex(tableNameOrIndexName: string, indexNameOrCb?: string | CallbackFunction, callback?: CallbackFunction): void;
-  addForeignKey(tableName: string, referencedTableName: string, keyName: string, fieldMapping: any, rules: ForeignKeyRules, callback: CallbackFunction): void;
-  removeForeignKey(tableName: string, keyName: string, optionsOrCb?: RemoveForeignKeyOptions | CallbackFunction, callback?: CallbackFunction): void;
-  normalizeColumnSpec(spec: string | ColumnSpec): ColumnSpec;
-  addMigrationRecord(name: string, callback: CallbackFunction): void;
-  addSeedRecord(name: string, callback: CallbackFunction): void;
-  startMigration(callback: CallbackFunction): void;
-  endMigration(callback: CallbackFunction): void;
-  runSql(sql?: string, paramsOrCb?: Array<any> | CallbackFunction, callback?: CallbackFunction): void;
-  allLoadedMigrations(callback: CallbackFunction): void;
-  allLoadedSeeds(callback: CallbackFunction): void;
-  deleteMigration(migrationName: string, callback: CallbackFunction): void;
-  remove(table: string, ids: any, callback: CallbackFunction): void;  // TODO Make ids match the type of ids in buildWhereClause(ids);
+  addIndex(tableName: string, indexName: string, columns: string | Array<string>, uniqueOrCb?: boolean | Base.CallbackFunction, callback?: Base.CallbackFunction): void;
+  insert(tableName: string, columnNameOrValueArray: any, valueArrayOrCb?: any | Base.CallbackFunction, callback?: Base.CallbackFunction): void;
+  update(tableName: string, columnNameOrValueArray: any, valueArrayOrIds?: any, idsOrCb?: any | Base.CallbackFunction, callback?: Base.CallbackFunction): void;
+  lookup(tableName: string, column: string, id?: any, callback?: Base.CallbackFunction): void;
+  removeIndex(tableNameOrIndexName: string, indexNameOrCb?: string | Base.CallbackFunction, callback?: Base.CallbackFunction): void;
+  addForeignKey(tableName: string, referencedTableName: string, keyName: string, fieldMapping: any, rules: Base.ForeignKeyRules, callback: Base.CallbackFunction): void;
+  removeForeignKey(tableName: string, keyName: string, optionsOrCb?: Base.RemoveForeignKeyOptions | Base.CallbackFunction, callback?: Base.CallbackFunction): void;
+  normalizeColumnSpec(spec: string | Base.ColumnSpec): Base.ColumnSpec;
+  addMigrationRecord(name: string, callback: Base.CallbackFunction): void;
+  addSeedRecord(name: string, callback: Base.CallbackFunction): void;
+  startMigration(callback: Base.CallbackFunction): void;
+  endMigration(callback: Base.CallbackFunction): void;
+  runSql(sql?: string, paramsOrCb?: Array<any> | Base.CallbackFunction, callback?: Base.CallbackFunction): void;
+  allLoadedMigrations(callback: Base.CallbackFunction): void;
+  allLoadedSeeds(callback: Base.CallbackFunction): void;
+  deleteMigration(migrationName: string, callback: Base.CallbackFunction): void;
+  remove(table: string, ids: any, callback: Base.CallbackFunction): void;  // TODO Make ids match the type of ids in buildWhereClause(ids);
   buildWhereClause(ids: any): string;
-  deleteSeed(seedName: string, callback: CallbackFunction): void;
-  all(sql: string, paramsOrCb?: Array<any> | CallbackFunction, callback?: CallbackFunction): void;
+  deleteSeed(seedName: string, callback: Base.CallbackFunction): void;
+  all(sql: string, paramsOrCb?: Array<any> | Base.CallbackFunction, callback?: Base.CallbackFunction): void;
   escape(str: string): string;
@@ -124,20 +126,20 @@ escapeString(str: string): string;
   createSeedsTableAsync(): Promise<any>;
-  createTableAsync(tableName: string, options: any | CreateTableOptions): Promise<any>;
-  dropTableAsync(tableName: string, options?: DropTableOptions): Promise<any>;
+  createTableAsync(tableName: string, options: any | Base.CreateTableOptions): Promise<any>;
+  dropTableAsync(tableName: string, options?: Base.DropTableOptions): Promise<any>;
   renameTableAsync(tableName: string, newTableName: string): Promise<any>;
-  addColumnAsync(tableName: string, columnName: string, columnSpec: ColumnSpec): Promise<any>;
+  addColumnAsync(tableName: string, columnName: string, columnSpec: Base.ColumnSpec): Promise<any>;
   removeColumnAsync(tableName: string, columnName: string): Promise<any>;
   renameColumnAsync(tableName: string, oldColumnName: string, newColumnName: string): Promise<any>;
-  changeColumnAsync(tableName: string, columnName: string, columnSpec: ColumnSpec): Promise<any>;
+  changeColumnAsync(tableName: string, columnName: string, columnSpec: Base.ColumnSpec): Promise<any>;
   addIndexAsync(tableName: string, indexName: string, columns: string | Array<string>, unique?: boolean): Promise<any>;
-  insertAsync(tableName: string, columnNameOrValueArray: any, valueArrayOrCb?: any | CallbackFunction, callback?: CallbackFunction): Promise<any>;
-  updateAsync(tableName: string, columnNameOrValueArray: any, valueArrayOrIds?: any, idsOrCb?: any | CallbackFunction, callback?: CallbackFunction): Promise<any>;
-  lookupAsync(tableName: string, column: string, id?: any, callback?: CallbackFunction): Promise<any>;
+  insertAsync(tableName: string, columnNameOrValueArray: any, valueArrayOrCb?: any | Base.CallbackFunction, callback?: Base.CallbackFunction): Promise<any>;
+  updateAsync(tableName: string, columnNameOrValueArray: any, valueArrayOrIds?: any, idsOrCb?: any | Base.CallbackFunction, callback?: Base.CallbackFunction): Promise<any>;
+  lookupAsync(tableName: string, column: string, id?: any, callback?: Base.CallbackFunction): Promise<any>;
   removeIndexAsync(tableNameOrIndexName: string, indexName?: string): Promise<any>;
-  addForeignKeyAsync(tableName: string, referencedTableName: string, keyName: string, fieldMapping: any, rules: ForeignKeyRules): Promise<any>;
-  removeForeignKeyAsync(tableName: string, keyName: string, options?: RemoveForeignKeyOptions): Promise<any>;
+  addForeignKeyAsync(tableName: string, referencedTableName: string, keyName: string, fieldMapping: any, rules: Base.ForeignKeyRules): Promise<any>;
+  removeForeignKeyAsync(tableName: string, keyName: string, options?: Base.RemoveForeignKeyOptions): Promise<any>;
   addMigrationRecordAsync(name: string): Promise<any>;
   addSeedRecordAsync(name: string): Promise<any>;
   startMigrationAsync(): Promise<any>;
-  endMigrationAsync(callback: CallbackFunction): Promise<any>;
+  endMigrationAsync(callback: Base.CallbackFunction): Promise<any>;
   runSqlAsync(sql?: string, params?: Array<any>): Promise<any>;
@@ -151,1 +153,3 @@ allLoadedMigrationsAsync(): Promise<any>;
 }
+
+export = Base;

db-migrate-base/package.json

 {
     "name": "@types/db-migrate-base",
-    "version": "0.0.7",
+    "version": "0.0.8",
     "description": "TypeScript definitions for db-migrate-base",
@@ -25,4 +25,4 @@ "license": "MIT",
     },
-    "typesPublisherContentHash": "b5fb70438ab2705baba6fe499d5dc5ef41722e9c8d2797620843bd71d05c869b",
+    "typesPublisherContentHash": "4c1b269c5aa9b9f80a87ca58f20e742459fa85f000f38969e9e5ad1c632bab36",
     "typeScriptVersion": "3.2"
 }

db-migrate-base/README.md

@@ -11,3 +11,3 @@ # Installation
 ### Additional Details
- * Last updated: Fri, 15 May 2020 04:09:04 GMT
+ * Last updated: Wed, 10 Jun 2020 15:51:25 GMT
  * Dependencies: [@types/bluebird](https://npmjs.com/package/@types/bluebird), [@types/node](https://npmjs.com/package/@types/node)
@@ -14,0 +14,0 @@ * Global values: none

No alert changes

Improved metrics

Total package byte prevSize

10659

5.12%

Lines of code

136

2.26%

No dependency changes