database-js - npm Package Compare versions

Comparing version 3.0.6 to 3.0.7

index.d.ts

@@ -1,316 +0,321 @@
-interface ConnectionStruct {
-    driverName?: string;
-    DriverName?: string;
-    username?:string;
-    Username?:string;
-    password?:string;
-    Password?:string;
-    hostname?:string;
-    Hostname?:string;
-    port?:string;
-    Port?:string;
-    database?:string;
-    Database?:string;
-    parameters?:string;
-    Parameters?:string;
-}
+declare namespace databasejs {
 
-declare class  ConnectionObject {
-    constructor(driverName: string, username: string, password: string, hostname: string, port: string, database: string, driver?: any);
+    interface ConnectionStruct {
+        driverName?: string;
+        DriverName?: string;
+        username?:string;
+        Username?:string;
+        password?:string;
+        Password?:string;
+        hostname?:string;
+        Hostname?:string;
+        port?:string;
+        Port?:string;
+        database?:string;
+        Database?:string;
+        parameters?:string;
+        Parameters?:string;
+    }
 
-    /** Splits the parameter string into an object of key/value pairs */
-    parseParameters() : Object;
+    class  ConnectionObject {
+        constructor(driverName: string, username: string, password: string, hostname: string, port: string, database: string, driver?: any);
 
-    /** Makes a URL from this ConnectionObject */
-    makeURL() : string;
+        /** Splits the parameter string into an object of key/value pairs */
+        parseParameters() : Object;
 
-    /** Allows plain object to be used to construct a ConnectionObject */
-    static fromPlain(obj: ConnectionStruct, driver?: any): ConnectionObject;
-}
+        /** Makes a URL from this ConnectionObject */
+        makeURL() : string;
 
-declare class Statement {
-    /**
-     * Executes the SQL query. If any parameters are required, they
-     * will be passed to the query here.
-     * 
-     * @param {any[]} args arguments to replace into the prepared SQL string
-     * @returns {Promise<Array<any>}
-     * @memberof Statement
-     */
-    query(... args: any[]) : Promise<Array<any>>;
+        /** Allows plain object to be used to construct a ConnectionObject */
+        static fromPlain(obj: ConnectionStruct, driver?: any): ConnectionObject;
+    }
 
-    /**
-     * Prepares the statement for use with parameters.
-     * 
-     * @memberof Statement
-     */
-    prepare() : void;
+    class Statement {
+        /**
+         * Executes the SQL query. If any parameters are required, they
+         * will be passed to the query here.
+         * 
+         * @param {any[]} args arguments to replace into the prepared SQL string
+         * @returns {Promise<Array<any>}
+         * @memberof Statement
+         */
+        query(... args: any[]) : Promise<Array<any>>;
 
-    /**
-     * Executes the SQL statement. If any parameters are required, they
-     * will be passed in here.
-     * 
-     * @param {any[]} args arguments to replace into the prepared SQL string
-     * @returns {Promise<any>}
-     * @memberof Statement
-     */
-    execute(... args: any[]) : Promise<void | Array<any>>;
-}
+        /**
+         * Prepares the statement for use with parameters.
+         * 
+         * @memberof Statement
+         */
+        prepare() : void;
 
-declare class PreparedStatement extends Statement {}
+        /**
+         * Executes the SQL statement. If any parameters are required, they
+         * will be passed in here.
+         * 
+         * @param {any[]} args arguments to replace into the prepared SQL string
+         * @returns {Promise<any>}
+         * @memberof Statement
+         */
+        execute(... args: any[]) : Promise<void | Array<any>>;
+    }
 
-declare class Connection {
-    constructor(url: string | ConnectionStruct, driver?: any);
+    class PreparedStatement extends Statement {}
 
-    readonly URL: string;
-    readonly Driver: Object;
-    
-    /**
-     * Creates a statement with the passed SQL.
-     * 
-     * @param {string} sql the SQL string to use for the statement
-     * @returns {Statement} a Statement object
-     * @memberof Connection
-     */
-    createStatement(sql: string) : Statement;
+    class Connection {
+        constructor(url: string | ConnectionStruct, driver?: any);
 
-    /**
-     * Creates and prepares a statement with the passed SQL.
-     * 
-     * @param {string} sql the SQL string to use for the statement
-     * @returns {PreparedStatement} a PreparedStatement object
-     * @memberof Connection
-     */
-    prepareStatement(sql: string) : PreparedStatement;
+        readonly URL: string;
+        readonly Driver: Object;
+        
+        /**
+         * Creates a statement with the passed SQL.
+         * 
+         * @param {string} sql the SQL string to use for the statement
+         * @returns {Statement} a Statement object
+         * @memberof Connection
+         */
+        createStatement(sql: string) : Statement;
 
-    /**
-     * Closes the underlying connection.
-     * 
-     * @returns {Promise<boolean>}
-     * @memberof Connection
-     */
-    close() : Promise<boolean>;
+        /**
+         * Creates and prepares a statement with the passed SQL.
+         * 
+         * @param {string} sql the SQL string to use for the statement
+         * @returns {PreparedStatement} a PreparedStatement object
+         * @memberof Connection
+         */
+        prepareStatement(sql: string) : PreparedStatement;
 
-    /**
-     * Indicates whether the underlying driver can support transactions;
-     * 
-     * @returns {boolean}
-     * @memberof Connection
-     */
-    isTransactionSupported() : boolean;
+        /**
+         * Closes the underlying connection.
+         * 
+         * @returns {Promise<boolean>}
+         * @memberof Connection
+         */
+        close() : Promise<boolean>;
 
-    /**
-     * Returns true if the underlying driver is in a transaction, false
-     * if it does not support transactions or is not in a transaction.
-     * 
-     * @returns {boolean}
-     * @memberof Connection
-     */
-    inTransaction() : boolean;
+        /**
+         * Indicates whether the underlying driver can support transactions;
+         * 
+         * @returns {boolean}
+         * @memberof Connection
+         */
+        isTransactionSupported() : boolean;
 
-    /**
-     * Returns a boolean promise: true if a transaction was started and
-     * false if it was not started. Transactions can fail to start if
-     * another transaction is already running or if the driver does 
-     * not support transactions.
-     * 
-     * @returns {Promise<boolean>}
-     * @memberof Connection
-     */
-    beginTransaction() : Promise<boolean>;
+        /**
+         * Returns true if the underlying driver is in a transaction, false
+         * if it does not support transactions or is not in a transaction.
+         * 
+         * @returns {boolean}
+         * @memberof Connection
+         */
+        inTransaction() : boolean;
 
-    /**
-     * Returns a boolean promise: true if a transaction was committed and
-     * false if one was not committed. Transactions can fail to commit if
-     * no transaction was started, or if the driver does not support
-     * transactions.
-     * 
-     * @returns {Promise<boolean>}
-     * @memberof Connection
-     */
-    commit() : Promise<boolean>;
+        /**
+         * Returns a boolean promise: true if a transaction was started and
+         * false if it was not started. Transactions can fail to start if
+         * another transaction is already running or if the driver does 
+         * not support transactions.
+         * 
+         * @returns {Promise<boolean>}
+         * @memberof Connection
+         */
+        beginTransaction() : Promise<boolean>;
 
-    /**
-     * Returns a boolean promise: true if a transaction was rolled back and
-     * false if one was not rolled back. Transactions can fail to roll back if
-     * no transaction was started, or if the driver does not support
-     * transactions.
-     * 
-     * @returns {Promise<boolean>}
-     * @memberof Connection
-     */
-    rollback() : Promise<boolean>;
-}
+        /**
+         * Returns a boolean promise: true if a transaction was committed and
+         * false if one was not committed. Transactions can fail to commit if
+         * no transaction was started, or if the driver does not support
+         * transactions.
+         * 
+         * @returns {Promise<boolean>}
+         * @memberof Connection
+         */
+        commit() : Promise<boolean>;
 
-declare class PooledConnection extends Connection {
-    /**
-     * Closes the connection completely
-     * 
-     * @returns {Promise<boolean>}
-     * @memberof PooledConnection
-     */
-    kill() : Promise<boolean>;
+        /**
+         * Returns a boolean promise: true if a transaction was rolled back and
+         * false if one was not rolled back. Transactions can fail to roll back if
+         * no transaction was started, or if the driver does not support
+         * transactions.
+         * 
+         * @returns {Promise<boolean>}
+         * @memberof Connection
+         */
+        rollback() : Promise<boolean>;
+    }
 
-    /**
-     * Frees this connection for the pool
-     * 
-     * @returns {Promise<boolean>}
-     * @memberof PooledConnection
-     */
-    close() : Promise<boolean>;
-}
+    class PooledConnection extends Connection {
+        /**
+         * Closes the connection completely
+         * 
+         * @returns {Promise<boolean>}
+         * @memberof PooledConnection
+         */
+        kill() : Promise<boolean>;
 
-declare interface Pool {
-    /**
-     * The number of used connections in the pool
-     * @returns {number}
-     * @readonly
-     * @memberof Pool
-     */
-    readonly Available : number;
+        /**
+         * Frees this connection for the pool
+         * 
+         * @returns {Promise<boolean>}
+         * @memberof PooledConnection
+         */
+        close() : Promise<boolean>;
+    }
 
-    /**
-     * The number of used connections in the pool
-     * @returns {number}
-     * @readonly
-     * @memberof Pool
-     */
-    readonly InUse : number;
+    interface Pool {
+        /**
+         * The number of used connections in the pool
+         * @returns {number}
+         * @readonly
+         * @memberof Pool
+         */
+        readonly Available : number;
 
-    /**
-     * The total number of connections in the pool
-     * @returns {number}
-     * @readonly
-     * @memberof Pool
-     */
-    readonly Count : number; 
+        /**
+         * The number of used connections in the pool
+         * @returns {number}
+         * @readonly
+         * @memberof Pool
+         */
+        readonly InUse : number;
 
-    /**
-     * The prefered number of connections in the pool
-     * @returns {number}
-     * @readonly
-     * @memberof Pool
-     */
-    readonly Size : number;
+        /**
+         * The total number of connections in the pool
+         * @returns {number}
+         * @readonly
+         * @memberof Pool
+         */
+        readonly Count : number; 
 
-    /**
-     * Grabs an available connection from the pool
-     * 
-     * @returns {PooledConnection}
-     * @memberof Pool
-     */
-    getConnection() : PooledConnection;
+        /**
+         * The prefered number of connections in the pool
+         * @returns {number}
+         * @readonly
+         * @memberof Pool
+         */
+        readonly Size : number;
 
-    /**
-     * Closes the underlying connections and empties the pool
-     * 
-     * @returns {Promise<Array<boolean>>}
-     * @memberof Pool
-     */
-    close() : Promise<Array<boolean>>
-}
+        /**
+         * Grabs an available connection from the pool
+         * 
+         * @returns {PooledConnection}
+         * @memberof Pool
+         */
+        getConnection() : PooledConnection;
 
-declare class StaticPool implements Pool {
-    constructor(url: string | ConnectionObject, poolSize: number, driver?: any);
-    
-    /**
-     * The number of used connections in the pool
-     * @returns {number}
-     * @readonly
-     * @memberof Pool
-     */
-    readonly Available : number;
+        /**
+         * Closes the underlying connections and empties the pool
+         * 
+         * @returns {Promise<Array<boolean>>}
+         * @memberof Pool
+         */
+        close() : Promise<Array<boolean>>
+    }
 
-    /**
-     * The number of used connections in the pool
-     * @returns {number}
-     * @readonly
-     * @memberof Pool
-     */
-    readonly InUse : number;
+    class StaticPool implements Pool {
+        constructor(url: string | ConnectionObject, poolSize: number, driver?: any);
+        
+        /**
+         * The number of used connections in the pool
+         * @returns {number}
+         * @readonly
+         * @memberof Pool
+         */
+        readonly Available : number;
 
-    /**
-     * The total number of connections in the pool
-     * @returns {number}
-     * @readonly
-     * @memberof Pool
-     */
-    readonly Count : number; 
+        /**
+         * The number of used connections in the pool
+         * @returns {number}
+         * @readonly
+         * @memberof Pool
+         */
+        readonly InUse : number;
 
-    /**
-     * The prefered number of connections in the pool
-     * @returns {number}
-     * @readonly
-     * @memberof Pool
-     */
-    readonly Size : number;
+        /**
+         * The total number of connections in the pool
+         * @returns {number}
+         * @readonly
+         * @memberof Pool
+         */
+        readonly Count : number; 
 
-    /**
-     * Grabs an available connection from the pool
-     * 
-     * @returns {PooledConnection}
-     * @memberof Pool
-     */
-    getConnection() : PooledConnection;
+        /**
+         * The prefered number of connections in the pool
+         * @returns {number}
+         * @readonly
+         * @memberof Pool
+         */
+        readonly Size : number;
 
-    /**
-     * Closes the underlying connections and empties the pool
-     * 
-     * @returns {Promise<Array<boolean>>}
-     * @memberof Pool
-     */
-    close() : Promise<Array<boolean>>
-}
+        /**
+         * Grabs an available connection from the pool
+         * 
+         * @returns {PooledConnection}
+         * @memberof Pool
+         */
+        getConnection() : PooledConnection;
 
-declare class DynamicPool implements Pool {
-    constructor(url: string | ConnectionObject, poolSize: number, driver?: any);
-    
-    /**
-     * The number of used connections in the pool
-     * @returns {number}
-     * @readonly
-     * @memberof Pool
-     */
-    readonly Available : number;
+        /**
+         * Closes the underlying connections and empties the pool
+         * 
+         * @returns {Promise<Array<boolean>>}
+         * @memberof Pool
+         */
+        close() : Promise<Array<boolean>>
+    }
 
-    /**
-     * The number of used connections in the pool
-     * @returns {number}
-     * @readonly
-     * @memberof Pool
-     */
-    readonly InUse : number;
+    class DynamicPool implements Pool {
+        constructor(url: string | ConnectionObject, poolSize: number, driver?: any);
+        
+        /**
+         * The number of used connections in the pool
+         * @returns {number}
+         * @readonly
+         * @memberof Pool
+         */
+        readonly Available : number;
 
-    /**
-     * The total number of connections in the pool
-     * @returns {number}
-     * @readonly
-     * @memberof Pool
-     */
-    readonly Count : number; 
+        /**
+         * The number of used connections in the pool
+         * @returns {number}
+         * @readonly
+         * @memberof Pool
+         */
+        readonly InUse : number;
 
-    /**
-     * The prefered number of connections in the pool
-     * @returns {number}
-     * @readonly
-     * @memberof Pool
-     */
-    readonly Size : number;
+        /**
+         * The total number of connections in the pool
+         * @returns {number}
+         * @readonly
+         * @memberof Pool
+         */
+        readonly Count : number; 
 
-    /**
-     * Grabs an available connection from the pool
-     * 
-     * @returns {PooledConnection}
-     * @memberof Pool
-     */
-    getConnection() : PooledConnection;
+        /**
+         * The prefered number of connections in the pool
+         * @returns {number}
+         * @readonly
+         * @memberof Pool
+         */
+        readonly Size : number;
 
-    /**
-     * Closes the underlying connections and empties the pool
-     * 
-     * @returns {Promise<Array<boolean>>}
-     * @memberof Pool
-     */
-    close() : Promise<Array<boolean>>
+        /**
+         * Grabs an available connection from the pool
+         * 
+         * @returns {PooledConnection}
+         * @memberof Pool
+         */
+        getConnection() : PooledConnection;
+
+        /**
+         * Closes the underlying connections and empties the pool
+         * 
+         * @returns {Promise<Array<boolean>>}
+         * @memberof Pool
+         */
+        close() : Promise<Array<boolean>>
+    }
+
 }
 
+export = databasejs;

package.json

 {
   "name": "database-js",
-  "version": "3.0.6",
+  "version": "3.0.7",
   "description": "Common Database Interface",
@@ -5,0 +5,0 @@ "main": "index.js",

No alert changes

Improved metrics

Total package byte prevSize

49386

increased by2.29%

Lines of code

1054

increased by0.19%

No dependency changes