From 9ab270ece8af1d010531ef6f1e9f8af0d993e20d Mon Sep 17 00:00:00 2001 From: Richard Natal Date: Mon, 1 Feb 2016 17:59:59 -0200 Subject: [PATCH 1/5] Impl: Added index.d.ts to expose types for typescript. --- index.d.ts | 521 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 521 insertions(+) create mode 100644 index.d.ts diff --git a/index.d.ts b/index.d.ts new file mode 100644 index 000000000..c8e05fc14 --- /dev/null +++ b/index.d.ts @@ -0,0 +1,521 @@ +// Type definitions for oracledb v1.6.0 +// Project: https://github.com/oracle/node-oracledb +// Definitions by: Richard Natal +// Definitions: https://github.com/oracle/node-oracledb + +/// + +declare module 'oracledb' { + import * as stream from "stream"; + + export interface ILob { + /** [Read-Only] This corresponds to the size used by the Oracle LOB layer when accessing or modifying the LOB value. */ + chunkSize: number; + /** [Read-Only] Length of a queried LOB in bytes (for BLOBs) or characters (for CLOBs). */ + length: number; + /** + * The number of bytes (for BLOBs) or characters (for CLOBs) to read for each Stream 'data' event of a queried LOB. + * The default value is chunkSize. + * For efficiency, it is recommended that pieceSize be a multiple of chunkSize. + * The maximum value for pieceSize is limited to the value of UINT_MAX. + */ + pieceSize: number; + offset?: number; + /** [Read-Only] This read-only attribute shows the type of Lob being used. It will have the value of one of the constants Oracledb.BLOB or Oracledb.CLOB. The value is derived from the bind type when using LOB bind variables, or from the column type when a LOB is returned by a query. */ + type: string; + /** + * Release method on ILob class. + * @remarks The cleanup() called by Release() only frees OCI error handle and Lob + * locator. These calls acquire mutex on OCI environment handle very briefly. + */ + release?(): void; + /** + * Read method on ILob class. + * @param {(err : any, chunk: string | Buffer) => void} callback Callback to recive the data from lob. + * @remarks CLobs send strings while BLobs send Buffer object. + */ + read?(callback: (err: any, chunk: string | Buffer) => void): void; + /** + * Read method on ILob class. + * @param {Buffer} data Data write into Lob. + * @param {(err: any) => void} callback Callback executed when writ is finished or when some error occured. + * @remarks CLobs send strings while BLobs send Buffer object. + */ + write?(data: Buffer, callback: (err: any) => void): void; + } + + export interface Lob extends stream.Duplex { + /** Internal - do not use it. */ + iLob: ILob; + /** [Read-Only] This corresponds to the size used by the Oracle LOB layer when accessing or modifying the LOB value. */ + chunkSize: number; + /** [Read-Only] Length of a queried LOB in bytes (for BLOBs) or characters (for CLOBs). */ + length: number; + /** + * The number of bytes (for BLOBs) or characters (for CLOBs) to read for each Stream 'data' event of a queried LOB. + * The default value is chunkSize. + * For efficiency, it is recommended that pieceSize be a multiple of chunkSize. + * The maximum value for pieceSize is limited to the value of UINT_MAX. + */ + pieceSize: number; + /** [Read-Only] This read-only attribute shows the type of Lob being used. It will have the value of one of the constants Oracledb.BLOB or Oracledb.CLOB. The value is derived from the bind type when using LOB bind variables, or from the column type when a LOB is returned by a query. */ + type: string; + + /** + * Do not call this... used internally by node-oracledb + */ + constructor(iLob: ILob, opts: stream.DuplexOptions): Lob; + constructor(iLob: ILob): Lob; + + /** + * Closes the current LOB. + * @param {(err: any) => void} callback? When passed, is called after the release. + * @returns void + */ + close(callback: (err: any) => void): void; + close(): void; + } + + export interface IConnectionAttributes { + /** + * The database user name. Can be a simple user name or a proxy of the form alison[fred]. See the Client Access Through Proxy section in the OCI manual for more details about proxy authentication. + */ + user?: string; + /** + * The password of the database user. A password is also necessary if a proxy user is specified. + */ + password?: string; + /** + * The Oracle database instance to connect to. The string can be an Easy Connect string, or a Net Service Name from a tnsnames.ora file, or the name of a local Oracle database instance. + */ + connectString: string; + /** + * The number of statements to be cached in the statement cache of each connection. This optional property may be used to override the stmtCacheSize property of the Oracledb object. + */ + stmtCacheSize?: number; + /** + * If this optional property is true then the pool's connections will be established using External Authentication. + * This property overrides the Oracledb externalAuth property. + * The user and password properties should not be set when externalAuth is true. + * Note prior to node-oracledb 0.5 this property was called isExternalAuth. + */ + externalAuth?: boolean; + } + + /** + * Provides connection credentials and pool-specific configuration properties, such as the maximum or minimum number of connections for the pool, or stmtCacheSize for the connections. The properties provided in the poolAttrs parameter override the default pooling properties in effect in the Oracledb object. + */ + export interface IPoolAttributes extends IConnectionAttributes { + /** + * The maximum number of connections to which a connection pool can grow. + * This optional property may be used to override the corresponding property in the Oracledb object. + */ + poolMax?: number; + /** + * The minimum number of connections a connection pool maintains, even when there is no activity to the target database. This optional property may be used to override the corresponding property in the Oracledb object. + */ + poolMin?: number; + /** + * The number of connections that are opened whenever a connection request exceeds the number of currently open connections. This optional property may be used to override the corresponding property in the Oracledb object. + */ + poolIncrement?: number; + /** + * The number of seconds after which idle connections (unused in the pool) may be terminated. Idle connections are terminated only when the pool is accessed. If the poolTimeout is set to 0, then idle connections are never terminated. + * This optional property may be used to override the corresponding property in the Oracledb object. + */ + poolTimeout?: number; + } + + /** + * This execute() function parameter is needed if there are bind variables in the statement, or if options are used. It can be either an object that associates values or JavaScript variables to the statement's bind variables by name, or an array of values or JavaScript variables that associate to the statement's bind variables by their relative positions. + */ + export interface IExecutionBinds { + /** + * The direction of the bind. One of the Oracledb Constants BIND_IN, BIND_INOUT, or BIND_OUT. + */ + dir?: number; + /** + * The number of array elements to be allocated for a PL/SQL Collection INDEX OF associative array OUT or IN OUT array bind variable. + */ + maxArraySize?: number; + /** + * The maximum number of bytes that an OUT or IN OUT bind variable of type STRING or BUFFER can use. The default value is 200. The maximum limit is 32767. + */ + maxSize?: number; + /** + * The datatype to be bound. One of the Oracledb Constants STRING, NUMBER, DATE, CURSOR or BUFFER. + */ + type?: number; + /** + * The input value or variable to be used for an IN or IN OUT bind variable. + */ + val?: any; + } + + export interface IExecuteOptions { + /** Maximum number of rows that will be retrieved. Used when resultSet is false. */ + maxRows?: number; + /** Number of rows to be fetched in advance. */ + prefetchRows?: number; + /** Result format - ARRAY o OBJECT */ + outFormat?: number; + /** Should use ResultSet or not. */ + resultSet?: boolean; + /** Transaction should auto commit after each statement? */ + autoCommit?: boolean; + /** + * Object defining how query column data should be represented in JavaScript. + * The fetchInfo property can be used to indicate that number or date columns in a query should be returned as strings instead of their native format. The property can be used in conjunction with, or instead of, the global setting fetchAsString. + * + * For example: + * + * fetchInfo: + * { + * "HIRE_DATE": { type : oracledb.STRING }, // return the date as a string + * "COMMISSION_PCT": { type : oracledb.DEFAULT } // override Oracledb.fetchAsString + * } + */ + fetchInfo?: Object; + } + + export interface IExecuteReturn { + /** Number o rows affected by the statement (used for inserts / updates)*/ + rowsAffected?: number; + /** When the statement has out parameters, it comes here. */ + outBinds?: Array | Object; + /** Metadata information - just columns names for now. */ + metaData?: Array; + /** When not using ResultSet, query results comes here. */ + rows?: Array> | Array; + /** When using ResultSet, query results comes here. */ + resultSet?: IResultSet; + } + + export interface IMetaData { + /** Column name */ + columnName: string; + } + + /** + * Result sets allow query results to fetched from the database one at a time, or in groups of rows. This enables applications to process very large data sets. + * Result sets should also be used where the number of query rows cannot be predicted and may be larger than a sensible maxRows size. + * A ResultSet object is obtained by setting resultSet: true in the options parameter of the Connection execute() method when executing a query. A ResultSet is also returned to node-oracledb when binding as type CURSOR to a PL/SQL REF CURSOR bind parameter. + * The value of prefetchRows can be adjusted to tune the performance of result sets. + */ + export interface IResultSet { + /** Metadata information - just columns names for now. */ + metaData?: Array; + /** + * Closes a ResultSet. Applications should always call this at the end of fetch or when no more rows are needed. + * @param {(err:any)=>void} callback Callback called on finish or when some error occurs + * @returns void + * @remarks After using a resultSet, it must be closed to free the resources used by the driver. + */ + close(callback: (err: any) => void): void; + /** + * This call fetches one row of the result set as an object or an array of column values, depending on the value of outFormat. + * At the end of fetching, the ResultSet should be freed by calling close(). + * @param {(err:any,row:Array|Object)=>void} callback Callback called when the row is available or when some error occurs. + * @returns void + */ + getRow(callback: (err: any, row: Array | Object) => void): void; + /** + * This call fetches numRows rows of the result set as an object or an array of column values, depending on the value of outFormat. + * At the end of fetching, the ResultSet should be freed by calling close(). + * @param {number} rowCount Number of rows to be fetched. + * @param {(err:any,rows:Array>|Array)=>void} callback Callback called when the rows are available, or when some error occurs. + * @returns void + * @remarks When the number of rows passed to the callback is less than the rowCount, no more rows are available to be fetched. + */ + getRows(rowCount: number, callback: (err: any, rows: Array> | Array) => void): void; + } + + export interface IConnection { + /** Statement cache size in bytes (read-only)*/ + stmtCacheSize: number; + /** + * The client identifier for end-to-end application tracing, use with mid-tier authentication, and with Virtual Private Databases. + * This is a write-only property. Displaying a Connection object will show a value of null for this attribute. See End-to-end Tracing, Mid-tier Authentication, and Auditing. + */ + clientId: string; + /** + * The module attribute for end-to-end application tracing. + * This is a write-only property. Displaying a Connection object will show a value of null for this attribute. See End-to-end Tracing, Mid-tier Authentication, and Auditing. + */ + module: string; + /** + * The action attribute for end-to-end application tracing. + * This is a write-only property. Displaying a Connection object will show a value of null for this attribute. See End-to-end Tracing, Mid-tier Authentication, and Auditing. + */ + action: string; + /** + * This readonly property gives a numeric representation of the Oracle database version. For version a.b.c.d.e, this property gives the number: (100000000 * a) + (1000000 * b) + (10000 * c) + (100 * d) + e + */ + oracleServerVersion: number; + + /** + * This call executes a SQL or PL/SQL statement. See SQL Execution for examples. + * This is an asynchronous call. + * The statement to be executed may contain IN binds, OUT or IN OUT bind values or variables, which are bound using either an object or an array. + * A callback function returns a result object, containing any fetched rows, the values of any OUT and IN OUT bind variables, and the number of rows affected by the execution of DML statements. + * @param {string} sql The SQL string that is executed. The SQL string may contain bind parameters. + * @param {Object|Array} Binds This function parameter is needed if there are bind parameters in the SQL statement. + * @param {IExecuteOptions} options This is an optional parameter to execute() that may be used to control statement execution. + * @param {(err: any, value: IExecuteReturn) => void} callback Callback function with the execution results. + */ + execute(sql: string, + binds: IExecutionBinds | Array, + options: IExecuteOptions, + callback: (err: any, value: IExecuteReturn) => void): void; + execute(sql: string, + binds: IExecutionBinds | Array, + callback: (err: any, value: IExecuteReturn) => void): void; + execute(sql: string, + callback: (err: any, value: IExecuteReturn) => void): void; + + /** + * Releases a connection. If the connection was obtained from the pool, the connection is returned to the pool. + * Note: calling release() when connections are no longer required is strongly encouraged. Releasing helps avoid resource leakage and can improve system efficiency. + * When a connection is released, any ongoing transaction on the connection is rolled back. + * After releasing a connection to a pool, there is no guarantee a subsequent getConnection() call gets back the same database connection. The application must redo any ALTER SESSION statements on the new connection object, as required. + * This is an asynchronous call. + * @param {(err: any) => void} callback Callback function to be called when the connection has been released. + */ + release(callback: (err: any) => void): void; + + /** + * This call commits the current transaction in progress on the connection. + * This is an asynchronous call. + * @param {(err: any) => void} callback Callback on commit done. + */ + commit(callback: (err: any) => void): void; + + /** + * SThis call rolls back the current transaction in progress on the connection. + * This is an asynchronous call. + * @param {(err: any) => void} callback Callback on rollback done. + */ + rollback(callback: (err: any) => void): void; + + /** + * This call stops the currently running operation on the connection. + * If there is no operation in progress or the operation has completed by the time the break is issued, the break() is effectively a no-op. + * If the running asynchronous operation is interrupted, its callback will return an error. + * This is an asynchronous call. + * @param {(err: any) => void} callback Callback on break done. + */ + break(callback: (err: any) => void): void; + } + + export interface IConnectionPool { + /** The maximum number of connections that can be open in the connection pool. */ + poolMax: number; + /** The minimum number of connections a connection pool maintains, even when there is no activity to the target database. */ + poolMin: number; + /** The number of connections that are opened whenever a connection request exceeds the number of currently open connections. */ + poolIncrement: number; + /** The time (in seconds) after which the pool terminates idle connections (unused in the pool). The number of connection does not drop below poolMin. */ + poolTimeout: number; + /** The number of currently open connections in the underlying connection pool. */ + connectionsOpen: number; + /** The number of currently active connections in the connection pool i.e. the number of connections currently checked-out using getConnection(). */ + connectionsInUse: number; + /** + * The number of statements to be cached in the statement cache of each connection. + * The default is the stmtCacheSize property of the Oracledb object when the pool is created. + */ + stmtCacheSize: number; + /** + * This call terminates the connection pool. + * Any open connections should be released with release() before terminate() is called. + * This is an asynchronous call. + * @param {(err:any)=>void} callback Callback called when the pool is terminated or when some error occurs + * @returns void + */ + terminate(callback: (err: any) => void): void; + /** + * This method obtains a connection from the connection pool. + * If a previously opened connection is available in the pool, that connection is returned. If all connections in the pool are in use, a new connection is created and returned to the caller, as long as the number of connections does not exceed the specified maximum for the pool. If the pool is at its maximum limit, the getConnection() call results in an error, such as ORA-24418: Cannot open further sessions. + * This is an asynchronous call. + * @param {(err:any,connection:IConnection)=>void} callback Callback called when the connection is available or when some error occurs. + * @returns void + * @see {@link https://jsao.io/2015/03/making-a-wrapper-module-for-the-node-js-driver-for-oracle-database/} + * @see {@link https://github.com/OraOpenSource/orawrap} + */ + getConnection(callback: (err: any, connection: IConnection) => void): void; + } + + /** For execute(): Used with fetchInfo to reset the fetch type to the database type */ + export const DEFAULT: number; + /** For execute(): Bind as JavaScript string type */ + export const STRING: number; + /** For execute(): Bind as JavaScript number type. Can also be used for fetchAsString and fetchInfo */ + export const NUMBER: number; + /** For execute(): Bind as JavaScript date type. Can also be used for fetchAsString and fetchInfo */ + export const DATE: number; + /** For execute(): Bind a REF CURSOR to a node-oracledb ResultSet class */ + export const CURSOR: number; + /** For execute(): Bind a RAW to a Node.js Buffer */ + export const BUFFER: number; + /** For execute(): Bind a CLOB to a Node.js Stream */ + export const CLOB: number; + /** For execute(): Bind a BLOB to a Node.js Stream */ + export const BLOB: number; + /** For execute(): Direction for IN binds */ + export const BIND_IN: number; + /** For execute(): Direction for IN OUT binds */ + export const BIND_INOUT: number; + /** For execute(): Direction for OUT binds */ + export const BIND_OUT: number; + /** For outFormat: Fetch each row as array of column values */ + export const ARRAY: number; + /** For outFormat: Fetch each row as an object */ + export const OBJECT: number; + + /** + * Do not use this method - used internally by node-oracledb. + */ + export function newLob(iLob: ILob): Lob; + + /** + * Obtains a connection directly from an Oracledb object. + * These connections are not pooled. For situations where connections are used infrequently, this call may be more efficient than creating and managing a connection pool. However, in most cases, Oracle recommends getting new connections from a connection pool. + * This is an asynchronous call. + * @param {IConnectionAttributes} connectionAttributes Parameters to stablish the connection. + * @param {(err:any,connection:IConnection)=>void} callback Callback to run when the connection gets stablished or when some error occurs. + * @returns void + */ + export function getConnection(connectionAttributes: IConnectionAttributes, callback: (err: any, connection: IConnection) => void): void; + + /** + * This method creates a pool of connections with the specified username, password and connection string. + * This is an asynchronous call. + * Internally, createPool() creates an OCI Session Pool for each Pool object. + * The default properties may be overridden by specifying new properties in the poolAttrs parameter. + * A pool should be terminated with the terminate() call. + * + * @param {IPoolAttributes} poolAttributes Parameters to stablish the connection pool. + * @param {(err:any,connection:IConnectionPool)=>void} callback Callback to run when the connection pool gets created or when some error occurs. + * @returns void + */ + export function createPool(poolAttributes: IPoolAttributes, callback: (err: any, connection: IConnectionPool) => void): void; + + + /** + * If this property is true, then the transaction in the current connection is automatically committed at the end of statement execution. + * The default value is false. + * This property may be overridden in an execute() call. + * Note prior to node-oracledb 0.5 this property was called isAutoCommit. + */ + export var autoCommit: boolean; + + /** + * If this property is true then connections are established using external authentication. See External Authentication for more information. + * The default value is false. + * The user and password properties for connecting or creating a pool should not be set when externalAuth is true. + * This property can be overridden in the Oracledb getConnection() or createPool() calls. + * Note prior to node-oracledb 0.5 this property was called isExternalAuth. + */ + export var externalAuth: boolean; + + /** + * The maximum number of connections to which a connection pool can grow. + * The default value is 4. + * This property may be overridden when creating the connection pool. + */ + export var poolMax: number; + + /** + * The minimum number of connections a connection pool maintains, even when there is no activity to the target database. + * The default value is 0. + * This property may be overridden when creating a connection pool. + */ + export var poolMin: number; + + /** + * The number of connections that are opened whenever a connection request exceeds the number of currently open connections. + * The default value is 1. + * This property may be overridden when creating a connection pool. + */ + export var poolIncrement: number; + + /** + * The number of seconds after which idle connections (unused in the pool) are terminated. Idle connections are terminated only when the pool is accessed. If the poolTimeout is set to 0, then idle connections are never terminated. + * The default value is 60. + * This property may be overridden when creating a connection pool. + */ + export var poolTimeout: number; + + /** + * The number of statements that are cached in the statement cache of each connection. + * The default value is 30. + * This property may be overridden for specific Pool or Connection objects. + * In general, set the statement cache to the size of the working set of statements being executed by the application. Statement caching can be disabled by setting the size to 0. + */ + export var stmtCacheSize: number; + + /** + * The number of additional rows the underlying Oracle client library fetches whenever node-oracledb requests query data from the database. + * Prefetching is a tuning option to maximize data transfer efficiency and minimize round-trips to the database. The prefetch size does not affect when, or how many, rows are returned by node-oracledb to the application. The cache management is transparently handled by the Oracle client libraries. + * prefetchRows is ignored unless a ResultSet is used. + * The default value is 100. + * This property may be overridden in an execute() call. + */ + export var prefetchRows: number; + + /** + * The maximum number of rows that are fetched by the execute() call of the Connection object when not using a ResultSet. Rows beyond this limit are not fetched from the database. + * The default value is 100. + * This property may be overridden in an execute() call. + * To improve database efficiency, SQL queries should use a row limiting clause like OFFSET / FETCH or equivalent. The maxRows property can be used to stop badly coded queries from returning unexpectedly large numbers of rows. + * Adjust maxRows as required by each application or query. Values that are larger than required can result in sub-optimal memory usage. + * maxRows is ignored when fetching rows with a ResultSet. + * When the number of query rows is relatively big, or can't be predicted, it is recommended to use a ResultSet. This prevents query results being unexpectedly truncated by the maxRows limit and removes the need to oversize maxRows to avoid such truncation. + */ + export var maxRows: number; + + /** + * The format of rows fetched when using the execute() call. This can be either of the Oracledb constants ARRAY or OBJECT. The default value is ARRAY which is more efficient. + * If specified as ARRAY, each row is fetched as an array of column values. + * If specified as OBJECT, each row is fetched as a JavaScript object. The object has a property for each column name, with the property value set to the respective column value. The property name follows Oracle's standard name-casing rules. It will commonly be uppercase, since most applications create tables using unquoted, case-insensitive names. + * This property may be overridden in an execute() call. + */ + export var outFormat: number; + + /** + * This readonly property gives a numeric representation of the node-oracledb version. For version x.y.z, this property gives the number: (10000 * x) + (100 * y) + z + */ + export var version: number; + + /** + * This attribute is temporarily disabled. Setting it has no effect. + * Node-oracledb internally uses Oracle LOB Locators to manipulate long object (LOB) data. LOB Prefetching allows LOB data to be returned early to node-oracledb when these locators are first returned. This is similar to the way row prefetching allows for efficient use of resources and round-trips between node-oracledb and the database. + * Prefetching of LOBs is mostly useful for small LOBs. + * The default size is 16384. + */ + export var lobPrefetchSize: number; + + /** + * This readonly property gives a numeric representation of the Oracle client library version. For version a.b.c.d.e, this property gives the number: (100000000 * a) + (1000000 * b) + (10000 * c) + (100 * d) + e + */ + export var oracleClientVersion: number; + + /** + * The user-chosen Connection class value defines a logical name for connections. Most single purpose applications should set connectionClass when using a connection pool or DRCP. + * When a pooled session has a connection class, Oracle ensures that the session is not shared outside of that connection class. + * The connection class value is similarly used by Database Resident Connection Pooling (DRCP) to allow or disallow sharing of sessions. + * For example, where two different kinds of users share one pool, you might set connectionClass to 'HRPOOL' for connections that access a Human Resources system, and it might be set to 'OEPOOL' for users of an Order Entry system. Users will only be given sessions of the appropriate class, allowing maximal reuse of resources in each case, and preventing any session information leaking between the two systems. + */ + export var connectionClass: string; + + /** + * An array of node-oracledb types. When any column having the specified type is queried with execute(), the column data is returned as a string instead of the native representation. For column types not specified in fetchAsString, native types will be returned. + * By default all columns are returned as native types. + * This property helps avoid situations where using JavaScript types can lead to numeric precision loss, or where date conversion is unwanted. + * The valid types that can be mapped to strings are DATE and NUMBER. + * The maximum length of a string created by this mapping is 200 bytes. + * Individual query columns in an execute() call can override the fetchAsString global setting by using fetchInfo. + * The conversion to string is handled by Oracle client libraries and is often referred to as defining the fetch type. + */ + export var fetchAsString: string; +} From fd868691811ff2f86a22a485971a8dbe1ed2f285 Mon Sep 17 00:00:00 2001 From: Richard Natal Date: Mon, 1 Feb 2016 18:12:19 -0200 Subject: [PATCH 2/5] Updated references to node.d.ts --- typings/main.d.ts | 1 + typings/main/ambient/node/node.d.ts | 2180 +++++++++++++++++++++++++++ 2 files changed, 2181 insertions(+) create mode 100644 typings/main.d.ts create mode 100644 typings/main/ambient/node/node.d.ts diff --git a/typings/main.d.ts b/typings/main.d.ts new file mode 100644 index 000000000..aa3b5cc0c --- /dev/null +++ b/typings/main.d.ts @@ -0,0 +1 @@ +/// diff --git a/typings/main/ambient/node/node.d.ts b/typings/main/ambient/node/node.d.ts new file mode 100644 index 000000000..b14dda075 --- /dev/null +++ b/typings/main/ambient/node/node.d.ts @@ -0,0 +1,2180 @@ +// Compiled using typings@0.6.4 +// Source: https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/1c56e368e17bb28ca57577250624ca5bd561aa81/node/node.d.ts +// Type definitions for Node.js v4.x +// Project: http://nodejs.org/ +// Definitions by: Microsoft TypeScript , DefinitelyTyped +// Definitions: https://github.com/borisyankov/DefinitelyTyped + +/************************************************ +* * +* Node.js v4.x API * +* * +************************************************/ + +interface Error { + stack?: string; +} + + +// compat for TypeScript 1.5.3 +// if you use with --target es3 or --target es5 and use below definitions, +// use the lib.es6.d.ts that is bundled with TypeScript 1.5.3. +interface MapConstructor {} +interface WeakMapConstructor {} +interface SetConstructor {} +interface WeakSetConstructor {} + +/************************************************ +* * +* GLOBAL * +* * +************************************************/ +declare var process: NodeJS.Process; +declare var global: NodeJS.Global; + +declare var __filename: string; +declare var __dirname: string; + +declare function setTimeout(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timer; +declare function clearTimeout(timeoutId: NodeJS.Timer): void; +declare function setInterval(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timer; +declare function clearInterval(intervalId: NodeJS.Timer): void; +declare function setImmediate(callback: (...args: any[]) => void, ...args: any[]): any; +declare function clearImmediate(immediateId: any): void; + +interface NodeRequireFunction { + (id: string): any; +} + +interface NodeRequire extends NodeRequireFunction { + resolve(id:string): string; + cache: any; + extensions: any; + main: any; +} + +declare var require: NodeRequire; + +interface NodeModule { + exports: any; + require: NodeRequireFunction; + id: string; + filename: string; + loaded: boolean; + parent: any; + children: any[]; +} + +declare var module: NodeModule; + +// Same as module.exports +declare var exports: any; +declare var SlowBuffer: { + new (str: string, encoding?: string): Buffer; + new (size: number): Buffer; + new (size: Uint8Array): Buffer; + new (array: any[]): Buffer; + prototype: Buffer; + isBuffer(obj: any): boolean; + byteLength(string: string, encoding?: string): number; + concat(list: Buffer[], totalLength?: number): Buffer; +}; + + +// Buffer class +interface Buffer extends NodeBuffer {} + +/** + * Raw data is stored in instances of the Buffer class. + * A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. + * Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex' + */ +declare var Buffer: { + /** + * Allocates a new buffer containing the given {str}. + * + * @param str String to store in buffer. + * @param encoding encoding to use, optional. Default is 'utf8' + */ + new (str: string, encoding?: string): Buffer; + /** + * Allocates a new buffer of {size} octets. + * + * @param size count of octets to allocate. + */ + new (size: number): Buffer; + /** + * Allocates a new buffer containing the given {array} of octets. + * + * @param array The octets to store. + */ + new (array: Uint8Array): Buffer; + /** + * Allocates a new buffer containing the given {array} of octets. + * + * @param array The octets to store. + */ + new (array: any[]): Buffer; + /** + * Copies the passed {buffer} data onto a new {Buffer} instance. + * + * @param buffer The buffer to copy. + */ + new (buffer: Buffer): Buffer; + prototype: Buffer; + /** + * Returns true if {obj} is a Buffer + * + * @param obj object to test. + */ + isBuffer(obj: any): obj is Buffer; + /** + * Returns true if {encoding} is a valid encoding argument. + * Valid string encodings in Node 0.12: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex' + * + * @param encoding string to test. + */ + isEncoding(encoding: string): boolean; + /** + * Gives the actual byte length of a string. encoding defaults to 'utf8'. + * This is not the same as String.prototype.length since that returns the number of characters in a string. + * + * @param string string to test. + * @param encoding encoding used to evaluate (defaults to 'utf8') + */ + byteLength(string: string, encoding?: string): number; + /** + * Returns a buffer which is the result of concatenating all the buffers in the list together. + * + * If the list has no items, or if the totalLength is 0, then it returns a zero-length buffer. + * If the list has exactly one item, then the first item of the list is returned. + * If the list has more than one item, then a new Buffer is created. + * + * @param list An array of Buffer objects to concatenate + * @param totalLength Total length of the buffers when concatenated. + * If totalLength is not provided, it is read from the buffers in the list. However, this adds an additional loop to the function, so it is faster to provide the length explicitly. + */ + concat(list: Buffer[], totalLength?: number): Buffer; + /** + * The same as buf1.compare(buf2). + */ + compare(buf1: Buffer, buf2: Buffer): number; +}; + +/************************************************ +* * +* GLOBAL INTERFACES * +* * +************************************************/ +declare module NodeJS { + export interface ErrnoException extends Error { + errno?: number; + code?: string; + path?: string; + syscall?: string; + stack?: string; + } + + export interface EventEmitter { + addListener(event: string, listener: Function): EventEmitter; + on(event: string, listener: Function): EventEmitter; + once(event: string, listener: Function): EventEmitter; + removeListener(event: string, listener: Function): EventEmitter; + removeAllListeners(event?: string): EventEmitter; + setMaxListeners(n: number): EventEmitter; + getMaxListeners(): number; + listeners(event: string): Function[]; + emit(event: string, ...args: any[]): boolean; + listenerCount(type: string): number; + } + + export interface ReadableStream extends EventEmitter { + readable: boolean; + read(size?: number): string|Buffer; + setEncoding(encoding: string): void; + pause(): void; + resume(): void; + pipe(destination: T, options?: { end?: boolean; }): T; + unpipe(destination?: T): void; + unshift(chunk: string): void; + unshift(chunk: Buffer): void; + wrap(oldStream: ReadableStream): ReadableStream; + } + + export interface WritableStream extends EventEmitter { + writable: boolean; + write(buffer: Buffer|string, cb?: Function): boolean; + write(str: string, encoding?: string, cb?: Function): boolean; + end(): void; + end(buffer: Buffer, cb?: Function): void; + end(str: string, cb?: Function): void; + end(str: string, encoding?: string, cb?: Function): void; + } + + export interface ReadWriteStream extends ReadableStream, WritableStream {} + + export interface Process extends EventEmitter { + stdout: WritableStream; + stderr: WritableStream; + stdin: ReadableStream; + argv: string[]; + execPath: string; + abort(): void; + chdir(directory: string): void; + cwd(): string; + env: any; + exit(code?: number): void; + getgid(): number; + setgid(id: number): void; + setgid(id: string): void; + getuid(): number; + setuid(id: number): void; + setuid(id: string): void; + version: string; + versions: { + http_parser: string; + node: string; + v8: string; + ares: string; + uv: string; + zlib: string; + openssl: string; + }; + config: { + target_defaults: { + cflags: any[]; + default_configuration: string; + defines: string[]; + include_dirs: string[]; + libraries: string[]; + }; + variables: { + clang: number; + host_arch: string; + node_install_npm: boolean; + node_install_waf: boolean; + node_prefix: string; + node_shared_openssl: boolean; + node_shared_v8: boolean; + node_shared_zlib: boolean; + node_use_dtrace: boolean; + node_use_etw: boolean; + node_use_openssl: boolean; + target_arch: string; + v8_no_strict_aliasing: number; + v8_use_snapshot: boolean; + visibility: string; + }; + }; + kill(pid:number, signal?: string|number): void; + pid: number; + title: string; + arch: string; + platform: string; + memoryUsage(): { rss: number; heapTotal: number; heapUsed: number; }; + nextTick(callback: Function): void; + umask(mask?: number): number; + uptime(): number; + hrtime(time?:number[]): number[]; + + // Worker + send?(message: any, sendHandle?: any): void; + } + + export interface Global { + Array: typeof Array; + ArrayBuffer: typeof ArrayBuffer; + Boolean: typeof Boolean; + Buffer: typeof Buffer; + DataView: typeof DataView; + Date: typeof Date; + Error: typeof Error; + EvalError: typeof EvalError; + Float32Array: typeof Float32Array; + Float64Array: typeof Float64Array; + Function: typeof Function; + GLOBAL: Global; + Infinity: typeof Infinity; + Int16Array: typeof Int16Array; + Int32Array: typeof Int32Array; + Int8Array: typeof Int8Array; + Intl: typeof Intl; + JSON: typeof JSON; + Map: MapConstructor; + Math: typeof Math; + NaN: typeof NaN; + Number: typeof Number; + Object: typeof Object; + Promise: Function; + RangeError: typeof RangeError; + ReferenceError: typeof ReferenceError; + RegExp: typeof RegExp; + Set: SetConstructor; + String: typeof String; + Symbol: Function; + SyntaxError: typeof SyntaxError; + TypeError: typeof TypeError; + URIError: typeof URIError; + Uint16Array: typeof Uint16Array; + Uint32Array: typeof Uint32Array; + Uint8Array: typeof Uint8Array; + Uint8ClampedArray: Function; + WeakMap: WeakMapConstructor; + WeakSet: WeakSetConstructor; + clearImmediate: (immediateId: any) => void; + clearInterval: (intervalId: NodeJS.Timer) => void; + clearTimeout: (timeoutId: NodeJS.Timer) => void; + console: typeof console; + decodeURI: typeof decodeURI; + decodeURIComponent: typeof decodeURIComponent; + encodeURI: typeof encodeURI; + encodeURIComponent: typeof encodeURIComponent; + escape: (str: string) => string; + eval: typeof eval; + global: Global; + isFinite: typeof isFinite; + isNaN: typeof isNaN; + parseFloat: typeof parseFloat; + parseInt: typeof parseInt; + process: Process; + root: Global; + setImmediate: (callback: (...args: any[]) => void, ...args: any[]) => any; + setInterval: (callback: (...args: any[]) => void, ms: number, ...args: any[]) => NodeJS.Timer; + setTimeout: (callback: (...args: any[]) => void, ms: number, ...args: any[]) => NodeJS.Timer; + undefined: typeof undefined; + unescape: (str: string) => string; + gc: () => void; + v8debug?: any; + } + + export interface Timer { + ref() : void; + unref() : void; + } +} + +/** + * @deprecated + */ +interface NodeBuffer { + [index: number]: number; + write(string: string, offset?: number, length?: number, encoding?: string): number; + toString(encoding?: string, start?: number, end?: number): string; + toJSON(): any; + length: number; + equals(otherBuffer: Buffer): boolean; + compare(otherBuffer: Buffer): number; + copy(targetBuffer: Buffer, targetStart?: number, sourceStart?: number, sourceEnd?: number): number; + slice(start?: number, end?: number): Buffer; + writeUIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number; + writeUIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number; + writeIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number; + writeIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number; + readUIntLE(offset: number, byteLength: number, noAssert?: boolean): number; + readUIntBE(offset: number, byteLength: number, noAssert?: boolean): number; + readIntLE(offset: number, byteLength: number, noAssert?: boolean): number; + readIntBE(offset: number, byteLength: number, noAssert?: boolean): number; + readUInt8(offset: number, noAsset?: boolean): number; + readUInt16LE(offset: number, noAssert?: boolean): number; + readUInt16BE(offset: number, noAssert?: boolean): number; + readUInt32LE(offset: number, noAssert?: boolean): number; + readUInt32BE(offset: number, noAssert?: boolean): number; + readInt8(offset: number, noAssert?: boolean): number; + readInt16LE(offset: number, noAssert?: boolean): number; + readInt16BE(offset: number, noAssert?: boolean): number; + readInt32LE(offset: number, noAssert?: boolean): number; + readInt32BE(offset: number, noAssert?: boolean): number; + readFloatLE(offset: number, noAssert?: boolean): number; + readFloatBE(offset: number, noAssert?: boolean): number; + readDoubleLE(offset: number, noAssert?: boolean): number; + readDoubleBE(offset: number, noAssert?: boolean): number; + writeUInt8(value: number, offset: number, noAssert?: boolean): number; + writeUInt16LE(value: number, offset: number, noAssert?: boolean): number; + writeUInt16BE(value: number, offset: number, noAssert?: boolean): number; + writeUInt32LE(value: number, offset: number, noAssert?: boolean): number; + writeUInt32BE(value: number, offset: number, noAssert?: boolean): number; + writeInt8(value: number, offset: number, noAssert?: boolean): number; + writeInt16LE(value: number, offset: number, noAssert?: boolean): number; + writeInt16BE(value: number, offset: number, noAssert?: boolean): number; + writeInt32LE(value: number, offset: number, noAssert?: boolean): number; + writeInt32BE(value: number, offset: number, noAssert?: boolean): number; + writeFloatLE(value: number, offset: number, noAssert?: boolean): number; + writeFloatBE(value: number, offset: number, noAssert?: boolean): number; + writeDoubleLE(value: number, offset: number, noAssert?: boolean): number; + writeDoubleBE(value: number, offset: number, noAssert?: boolean): number; + fill(value: any, offset?: number, end?: number): Buffer; + indexOf(value: string | number | Buffer, byteOffset?: number): number; +} + +/************************************************ +* * +* MODULES * +* * +************************************************/ +declare module "buffer" { + export var INSPECT_MAX_BYTES: number; +} + +declare module "querystring" { + export interface StringifyOptions { + encodeURIComponent?: Function; + } + + export interface ParseOptions { + maxKeys?: number; + decodeURIComponent?: Function; + } + + export function stringify(obj: T, sep?: string, eq?: string, options?: StringifyOptions): string; + export function parse(str: string, sep?: string, eq?: string, options?: ParseOptions): any; + export function parse(str: string, sep?: string, eq?: string, options?: ParseOptions): T; + export function escape(str: string): string; + export function unescape(str: string): string; +} + +declare module "events" { + export class EventEmitter implements NodeJS.EventEmitter { + static EventEmitter: EventEmitter; + static listenerCount(emitter: EventEmitter, event: string): number; // deprecated + static defaultMaxListeners: number; + + addListener(event: string, listener: Function): EventEmitter; + on(event: string, listener: Function): EventEmitter; + once(event: string, listener: Function): EventEmitter; + removeListener(event: string, listener: Function): EventEmitter; + removeAllListeners(event?: string): EventEmitter; + setMaxListeners(n: number): EventEmitter; + getMaxListeners(): number; + listeners(event: string): Function[]; + emit(event: string, ...args: any[]): boolean; + listenerCount(type: string): number; + } +} + +declare module "http" { + import * as events from "events"; + import * as net from "net"; + import * as stream from "stream"; + + export interface RequestOptions { + protocol?: string; + host?: string; + hostname?: string; + family?: number; + port?: number; + localAddress?: string; + socketPath?: string; + method?: string; + path?: string; + headers?: { [key: string]: any }; + auth?: string; + agent?: Agent|boolean; + } + + export interface Server extends events.EventEmitter { + listen(port: number, hostname?: string, backlog?: number, callback?: Function): Server; + listen(port: number, hostname?: string, callback?: Function): Server; + listen(path: string, callback?: Function): Server; + listen(handle: any, listeningListener?: Function): Server; + close(cb?: any): Server; + address(): { port: number; family: string; address: string; }; + maxHeadersCount: number; + } + /** + * @deprecated Use IncomingMessage + */ + export interface ServerRequest extends IncomingMessage { + connection: net.Socket; + } + export interface ServerResponse extends events.EventEmitter, stream.Writable { + // Extended base methods + write(buffer: Buffer): boolean; + write(buffer: Buffer, cb?: Function): boolean; + write(str: string, cb?: Function): boolean; + write(str: string, encoding?: string, cb?: Function): boolean; + write(str: string, encoding?: string, fd?: string): boolean; + + writeContinue(): void; + writeHead(statusCode: number, reasonPhrase?: string, headers?: any): void; + writeHead(statusCode: number, headers?: any): void; + statusCode: number; + statusMessage: string; + headersSent: boolean; + setHeader(name: string, value: string): void; + sendDate: boolean; + getHeader(name: string): string; + removeHeader(name: string): void; + write(chunk: any, encoding?: string): any; + addTrailers(headers: any): void; + + // Extended base methods + end(): void; + end(buffer: Buffer, cb?: Function): void; + end(str: string, cb?: Function): void; + end(str: string, encoding?: string, cb?: Function): void; + end(data?: any, encoding?: string): void; + } + export interface ClientRequest extends events.EventEmitter, stream.Writable { + // Extended base methods + write(buffer: Buffer): boolean; + write(buffer: Buffer, cb?: Function): boolean; + write(str: string, cb?: Function): boolean; + write(str: string, encoding?: string, cb?: Function): boolean; + write(str: string, encoding?: string, fd?: string): boolean; + + write(chunk: any, encoding?: string): void; + abort(): void; + setTimeout(timeout: number, callback?: Function): void; + setNoDelay(noDelay?: boolean): void; + setSocketKeepAlive(enable?: boolean, initialDelay?: number): void; + + // Extended base methods + end(): void; + end(buffer: Buffer, cb?: Function): void; + end(str: string, cb?: Function): void; + end(str: string, encoding?: string, cb?: Function): void; + end(data?: any, encoding?: string): void; + } + export interface IncomingMessage extends events.EventEmitter, stream.Readable { + httpVersion: string; + headers: any; + rawHeaders: string[]; + trailers: any; + rawTrailers: any; + setTimeout(msecs: number, callback: Function): NodeJS.Timer; + /** + * Only valid for request obtained from http.Server. + */ + method?: string; + /** + * Only valid for request obtained from http.Server. + */ + url?: string; + /** + * Only valid for response obtained from http.ClientRequest. + */ + statusCode?: number; + /** + * Only valid for response obtained from http.ClientRequest. + */ + statusMessage?: string; + socket: net.Socket; + } + /** + * @deprecated Use IncomingMessage + */ + export interface ClientResponse extends IncomingMessage { } + + export interface AgentOptions { + /** + * Keep sockets around in a pool to be used by other requests in the future. Default = false + */ + keepAlive?: boolean; + /** + * When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000. + * Only relevant if keepAlive is set to true. + */ + keepAliveMsecs?: number; + /** + * Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity + */ + maxSockets?: number; + /** + * Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256. + */ + maxFreeSockets?: number; + } + + export class Agent { + maxSockets: number; + sockets: any; + requests: any; + + constructor(opts?: AgentOptions); + + /** + * Destroy any sockets that are currently in use by the agent. + * It is usually not necessary to do this. However, if you are using an agent with KeepAlive enabled, + * then it is best to explicitly shut down the agent when you know that it will no longer be used. Otherwise, + * sockets may hang open for quite a long time before the server terminates them. + */ + destroy(): void; + } + + export var METHODS: string[]; + + export var STATUS_CODES: { + [errorCode: number]: string; + [errorCode: string]: string; + }; + export function createServer(requestListener?: (request: IncomingMessage, response: ServerResponse) =>void ): Server; + export function createClient(port?: number, host?: string): any; + export function request(options: RequestOptions, callback?: (res: IncomingMessage) => void): ClientRequest; + export function get(options: any, callback?: (res: IncomingMessage) => void): ClientRequest; + export var globalAgent: Agent; +} + +declare module "cluster" { + import * as child from "child_process"; + import * as events from "events"; + + export interface ClusterSettings { + exec?: string; + args?: string[]; + silent?: boolean; + } + + export class Worker extends events.EventEmitter { + id: string; + process: child.ChildProcess; + suicide: boolean; + send(message: any, sendHandle?: any): void; + kill(signal?: string): void; + destroy(signal?: string): void; + disconnect(): void; + } + + export var settings: ClusterSettings; + export var isMaster: boolean; + export var isWorker: boolean; + export function setupMaster(settings?: ClusterSettings): void; + export function fork(env?: any): Worker; + export function disconnect(callback?: Function): void; + export var worker: Worker; + export var workers: Worker[]; + + // Event emitter + export function addListener(event: string, listener: Function): void; + export function on(event: "disconnect", listener: (worker: Worker) => void): void; + export function on(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): void; + export function on(event: "fork", listener: (worker: Worker) => void): void; + export function on(event: "listening", listener: (worker: Worker, address: any) => void): void; + export function on(event: "message", listener: (worker: Worker, message: any) => void): void; + export function on(event: "online", listener: (worker: Worker) => void): void; + export function on(event: "setup", listener: (settings: any) => void): void; + export function on(event: string, listener: Function): any; + export function once(event: string, listener: Function): void; + export function removeListener(event: string, listener: Function): void; + export function removeAllListeners(event?: string): void; + export function setMaxListeners(n: number): void; + export function listeners(event: string): Function[]; + export function emit(event: string, ...args: any[]): boolean; +} + +declare module "zlib" { + import * as stream from "stream"; + export interface ZlibOptions { chunkSize?: number; windowBits?: number; level?: number; memLevel?: number; strategy?: number; dictionary?: any; } + + export interface Gzip extends stream.Transform { } + export interface Gunzip extends stream.Transform { } + export interface Deflate extends stream.Transform { } + export interface Inflate extends stream.Transform { } + export interface DeflateRaw extends stream.Transform { } + export interface InflateRaw extends stream.Transform { } + export interface Unzip extends stream.Transform { } + + export function createGzip(options?: ZlibOptions): Gzip; + export function createGunzip(options?: ZlibOptions): Gunzip; + export function createDeflate(options?: ZlibOptions): Deflate; + export function createInflate(options?: ZlibOptions): Inflate; + export function createDeflateRaw(options?: ZlibOptions): DeflateRaw; + export function createInflateRaw(options?: ZlibOptions): InflateRaw; + export function createUnzip(options?: ZlibOptions): Unzip; + + export function deflate(buf: Buffer, callback: (error: Error, result: any) =>void ): void; + export function deflateSync(buf: Buffer, options?: ZlibOptions): any; + export function deflateRaw(buf: Buffer, callback: (error: Error, result: any) =>void ): void; + export function deflateRawSync(buf: Buffer, options?: ZlibOptions): any; + export function gzip(buf: Buffer, callback: (error: Error, result: any) =>void ): void; + export function gzipSync(buf: Buffer, options?: ZlibOptions): any; + export function gunzip(buf: Buffer, callback: (error: Error, result: any) =>void ): void; + export function gunzipSync(buf: Buffer, options?: ZlibOptions): any; + export function inflate(buf: Buffer, callback: (error: Error, result: any) =>void ): void; + export function inflateSync(buf: Buffer, options?: ZlibOptions): any; + export function inflateRaw(buf: Buffer, callback: (error: Error, result: any) =>void ): void; + export function inflateRawSync(buf: Buffer, options?: ZlibOptions): any; + export function unzip(buf: Buffer, callback: (error: Error, result: any) =>void ): void; + export function unzipSync(buf: Buffer, options?: ZlibOptions): any; + + // Constants + export var Z_NO_FLUSH: number; + export var Z_PARTIAL_FLUSH: number; + export var Z_SYNC_FLUSH: number; + export var Z_FULL_FLUSH: number; + export var Z_FINISH: number; + export var Z_BLOCK: number; + export var Z_TREES: number; + export var Z_OK: number; + export var Z_STREAM_END: number; + export var Z_NEED_DICT: number; + export var Z_ERRNO: number; + export var Z_STREAM_ERROR: number; + export var Z_DATA_ERROR: number; + export var Z_MEM_ERROR: number; + export var Z_BUF_ERROR: number; + export var Z_VERSION_ERROR: number; + export var Z_NO_COMPRESSION: number; + export var Z_BEST_SPEED: number; + export var Z_BEST_COMPRESSION: number; + export var Z_DEFAULT_COMPRESSION: number; + export var Z_FILTERED: number; + export var Z_HUFFMAN_ONLY: number; + export var Z_RLE: number; + export var Z_FIXED: number; + export var Z_DEFAULT_STRATEGY: number; + export var Z_BINARY: number; + export var Z_TEXT: number; + export var Z_ASCII: number; + export var Z_UNKNOWN: number; + export var Z_DEFLATED: number; + export var Z_NULL: number; +} + +declare module "os" { + export interface CpuInfo { + model: string; + speed: number; + times: { + user: number; + nice: number; + sys: number; + idle: number; + irq: number; + }; + } + + export interface NetworkInterfaceInfo { + address: string; + netmask: string; + family: string; + mac: string; + internal: boolean; + } + + export function tmpdir(): string; + export function homedir(): string; + export function endianness(): string; + export function hostname(): string; + export function type(): string; + export function platform(): string; + export function arch(): string; + export function release(): string; + export function uptime(): number; + export function loadavg(): number[]; + export function totalmem(): number; + export function freemem(): number; + export function cpus(): CpuInfo[]; + export function networkInterfaces(): {[index: string]: NetworkInterfaceInfo[]}; + export var EOL: string; +} + +declare module "https" { + import * as tls from "tls"; + import * as events from "events"; + import * as http from "http"; + + export interface ServerOptions { + pfx?: any; + key?: any; + passphrase?: string; + cert?: any; + ca?: any; + crl?: any; + ciphers?: string; + honorCipherOrder?: boolean; + requestCert?: boolean; + rejectUnauthorized?: boolean; + NPNProtocols?: any; + SNICallback?: (servername: string) => any; + } + + export interface RequestOptions extends http.RequestOptions{ + pfx?: any; + key?: any; + passphrase?: string; + cert?: any; + ca?: any; + ciphers?: string; + rejectUnauthorized?: boolean; + secureProtocol?: string; + } + + export interface Agent { + maxSockets: number; + sockets: any; + requests: any; + } + export var Agent: { + new (options?: RequestOptions): Agent; + }; + export interface Server extends tls.Server { } + export function createServer(options: ServerOptions, requestListener?: Function): Server; + export function request(options: RequestOptions, callback?: (res: http.IncomingMessage) =>void ): http.ClientRequest; + export function get(options: RequestOptions, callback?: (res: http.IncomingMessage) =>void ): http.ClientRequest; + export var globalAgent: Agent; +} + +declare module "punycode" { + export function decode(string: string): string; + export function encode(string: string): string; + export function toUnicode(domain: string): string; + export function toASCII(domain: string): string; + export var ucs2: ucs2; + interface ucs2 { + decode(string: string): number[]; + encode(codePoints: number[]): string; + } + export var version: any; +} + +declare module "repl" { + import * as stream from "stream"; + import * as events from "events"; + + export interface ReplOptions { + prompt?: string; + input?: NodeJS.ReadableStream; + output?: NodeJS.WritableStream; + terminal?: boolean; + eval?: Function; + useColors?: boolean; + useGlobal?: boolean; + ignoreUndefined?: boolean; + writer?: Function; + } + export function start(options: ReplOptions): events.EventEmitter; +} + +declare module "readline" { + import * as events from "events"; + import * as stream from "stream"; + + export interface Key { + sequence?: string; + name?: string; + ctrl?: boolean; + meta?: boolean; + shift?: boolean; + } + + export interface ReadLine extends events.EventEmitter { + setPrompt(prompt: string): void; + prompt(preserveCursor?: boolean): void; + question(query: string, callback: (answer: string) => void): void; + pause(): ReadLine; + resume(): ReadLine; + close(): void; + write(data: string|Buffer, key?: Key): void; + } + + export interface Completer { + (line: string): CompleterResult; + (line: string, callback: (err: any, result: CompleterResult) => void): any; + } + + export interface CompleterResult { + completions: string[]; + line: string; + } + + export interface ReadLineOptions { + input: NodeJS.ReadableStream; + output?: NodeJS.WritableStream; + completer?: Completer; + terminal?: boolean; + historySize?: number; + } + + export function createInterface(input: NodeJS.ReadableStream, output?: NodeJS.WritableStream, completer?: Completer, terminal?: boolean): ReadLine; + export function createInterface(options: ReadLineOptions): ReadLine; + + export function cursorTo(stream: NodeJS.WritableStream, x: number, y: number): void; + export function moveCursor(stream: NodeJS.WritableStream, dx: number|string, dy: number|string): void; + export function clearLine(stream: NodeJS.WritableStream, dir: number): void; + export function clearScreenDown(stream: NodeJS.WritableStream): void; +} + +declare module "vm" { + export interface Context { } + export interface Script { + runInThisContext(): void; + runInNewContext(sandbox?: Context): void; + } + export function runInThisContext(code: string, filename?: string): void; + export function runInNewContext(code: string, sandbox?: Context, filename?: string): void; + export function runInContext(code: string, context: Context, filename?: string): void; + export function createContext(initSandbox?: Context): Context; + export function createScript(code: string, filename?: string): Script; +} + +declare module "child_process" { + import * as events from "events"; + import * as stream from "stream"; + + export interface ChildProcess extends events.EventEmitter { + stdin: stream.Writable; + stdout: stream.Readable; + stderr: stream.Readable; + pid: number; + kill(signal?: string): void; + send(message: any, sendHandle?: any): void; + disconnect(): void; + unref(): void; + } + + export function spawn(command: string, args?: string[], options?: { + cwd?: string; + stdio?: any; + custom?: any; + env?: any; + detached?: boolean; + }): ChildProcess; + export function exec(command: string, options: { + cwd?: string; + stdio?: any; + customFds?: any; + env?: any; + encoding?: string; + timeout?: number; + maxBuffer?: number; + killSignal?: string; + }, callback?: (error: Error, stdout: Buffer, stderr: Buffer) =>void ): ChildProcess; + export function exec(command: string, callback?: (error: Error, stdout: Buffer, stderr: Buffer) =>void ): ChildProcess; + export function execFile(file: string, + callback?: (error: Error, stdout: Buffer, stderr: Buffer) =>void ): ChildProcess; + export function execFile(file: string, args?: string[], + callback?: (error: Error, stdout: Buffer, stderr: Buffer) =>void ): ChildProcess; + export function execFile(file: string, args?: string[], options?: { + cwd?: string; + stdio?: any; + customFds?: any; + env?: any; + encoding?: string; + timeout?: number; + maxBuffer?: number; + killSignal?: string; + }, callback?: (error: Error, stdout: Buffer, stderr: Buffer) =>void ): ChildProcess; + export function fork(modulePath: string, args?: string[], options?: { + cwd?: string; + env?: any; + execPath?: string; + execArgv?: string[]; + silent?: boolean; + uid?: number; + gid?: number; + }): ChildProcess; + export function spawnSync(command: string, args?: string[], options?: { + cwd?: string; + input?: string | Buffer; + stdio?: any; + env?: any; + uid?: number; + gid?: number; + timeout?: number; + maxBuffer?: number; + killSignal?: string; + encoding?: string; + }): { + pid: number; + output: string[]; + stdout: string | Buffer; + stderr: string | Buffer; + status: number; + signal: string; + error: Error; + }; + export function execSync(command: string, options?: { + cwd?: string; + input?: string|Buffer; + stdio?: any; + env?: any; + uid?: number; + gid?: number; + timeout?: number; + maxBuffer?: number; + killSignal?: string; + encoding?: string; + }): string | Buffer; + export function execFileSync(command: string, args?: string[], options?: { + cwd?: string; + input?: string|Buffer; + stdio?: any; + env?: any; + uid?: number; + gid?: number; + timeout?: number; + maxBuffer?: number; + killSignal?: string; + encoding?: string; + }): string | Buffer; +} + +declare module "url" { + export interface Url { + href?: string; + protocol?: string; + auth?: string; + hostname?: string; + port?: string; + host?: string; + pathname?: string; + search?: string; + query?: any; // string | Object + slashes?: boolean; + hash?: string; + path?: string; + } + + export function parse(urlStr: string, parseQueryString?: boolean , slashesDenoteHost?: boolean ): Url; + export function format(url: Url): string; + export function resolve(from: string, to: string): string; +} + +declare module "dns" { + export function lookup(domain: string, family: number, callback: (err: Error, address: string, family: number) =>void ): string; + export function lookup(domain: string, callback: (err: Error, address: string, family: number) =>void ): string; + export function resolve(domain: string, rrtype: string, callback: (err: Error, addresses: string[]) =>void ): string[]; + export function resolve(domain: string, callback: (err: Error, addresses: string[]) =>void ): string[]; + export function resolve4(domain: string, callback: (err: Error, addresses: string[]) =>void ): string[]; + export function resolve6(domain: string, callback: (err: Error, addresses: string[]) =>void ): string[]; + export function resolveMx(domain: string, callback: (err: Error, addresses: string[]) =>void ): string[]; + export function resolveTxt(domain: string, callback: (err: Error, addresses: string[]) =>void ): string[]; + export function resolveSrv(domain: string, callback: (err: Error, addresses: string[]) =>void ): string[]; + export function resolveNs(domain: string, callback: (err: Error, addresses: string[]) =>void ): string[]; + export function resolveCname(domain: string, callback: (err: Error, addresses: string[]) =>void ): string[]; + export function reverse(ip: string, callback: (err: Error, domains: string[]) =>void ): string[]; +} + +declare module "net" { + import * as stream from "stream"; + + export interface Socket extends stream.Duplex { + // Extended base methods + write(buffer: Buffer): boolean; + write(buffer: Buffer, cb?: Function): boolean; + write(str: string, cb?: Function): boolean; + write(str: string, encoding?: string, cb?: Function): boolean; + write(str: string, encoding?: string, fd?: string): boolean; + + connect(port: number, host?: string, connectionListener?: Function): void; + connect(path: string, connectionListener?: Function): void; + bufferSize: number; + setEncoding(encoding?: string): void; + write(data: any, encoding?: string, callback?: Function): void; + destroy(): void; + pause(): void; + resume(): void; + setTimeout(timeout: number, callback?: Function): void; + setNoDelay(noDelay?: boolean): void; + setKeepAlive(enable?: boolean, initialDelay?: number): void; + address(): { port: number; family: string; address: string; }; + unref(): void; + ref(): void; + + remoteAddress: string; + remoteFamily: string; + remotePort: number; + localAddress: string; + localPort: number; + bytesRead: number; + bytesWritten: number; + + // Extended base methods + end(): void; + end(buffer: Buffer, cb?: Function): void; + end(str: string, cb?: Function): void; + end(str: string, encoding?: string, cb?: Function): void; + end(data?: any, encoding?: string): void; + } + + export var Socket: { + new (options?: { fd?: string; type?: string; allowHalfOpen?: boolean; }): Socket; + }; + + export interface Server extends Socket { + listen(port: number, host?: string, backlog?: number, listeningListener?: Function): Server; + listen(path: string, listeningListener?: Function): Server; + listen(handle: any, listeningListener?: Function): Server; + close(callback?: Function): Server; + address(): { port: number; family: string; address: string; }; + maxConnections: number; + connections: number; + } + export function createServer(connectionListener?: (socket: Socket) =>void ): Server; + export function createServer(options?: { allowHalfOpen?: boolean; }, connectionListener?: (socket: Socket) =>void ): Server; + export function connect(options: { port: number, host?: string, localAddress? : string, localPort? : string, family? : number, allowHalfOpen?: boolean; }, connectionListener?: Function): Socket; + export function connect(port: number, host?: string, connectionListener?: Function): Socket; + export function connect(path: string, connectionListener?: Function): Socket; + export function createConnection(options: { port: number, host?: string, localAddress? : string, localPort? : string, family? : number, allowHalfOpen?: boolean; }, connectionListener?: Function): Socket; + export function createConnection(port: number, host?: string, connectionListener?: Function): Socket; + export function createConnection(path: string, connectionListener?: Function): Socket; + export function isIP(input: string): number; + export function isIPv4(input: string): boolean; + export function isIPv6(input: string): boolean; +} + +declare module "dgram" { + import * as events from "events"; + + interface RemoteInfo { + address: string; + port: number; + size: number; + } + + interface AddressInfo { + address: string; + family: string; + port: number; + } + + export function createSocket(type: string, callback?: (msg: Buffer, rinfo: RemoteInfo) => void): Socket; + + interface Socket extends events.EventEmitter { + send(buf: Buffer, offset: number, length: number, port: number, address: string, callback?: (error: Error, bytes: number) => void): void; + bind(port: number, address?: string, callback?: () => void): void; + close(): void; + address(): AddressInfo; + setBroadcast(flag: boolean): void; + setMulticastTTL(ttl: number): void; + setMulticastLoopback(flag: boolean): void; + addMembership(multicastAddress: string, multicastInterface?: string): void; + dropMembership(multicastAddress: string, multicastInterface?: string): void; + } +} + +declare module "fs" { + import * as stream from "stream"; + import * as events from "events"; + + interface Stats { + isFile(): boolean; + isDirectory(): boolean; + isBlockDevice(): boolean; + isCharacterDevice(): boolean; + isSymbolicLink(): boolean; + isFIFO(): boolean; + isSocket(): boolean; + dev: number; + ino: number; + mode: number; + nlink: number; + uid: number; + gid: number; + rdev: number; + size: number; + blksize: number; + blocks: number; + atime: Date; + mtime: Date; + ctime: Date; + birthtime: Date; + } + + interface FSWatcher extends events.EventEmitter { + close(): void; + } + + export interface ReadStream extends stream.Readable { + close(): void; + } + export interface WriteStream extends stream.Writable { + close(): void; + bytesWritten: number; + } + + /** + * Asynchronous rename. + * @param oldPath + * @param newPath + * @param callback No arguments other than a possible exception are given to the completion callback. + */ + export function rename(oldPath: string, newPath: string, callback?: (err?: NodeJS.ErrnoException) => void): void; + /** + * Synchronous rename + * @param oldPath + * @param newPath + */ + export function renameSync(oldPath: string, newPath: string): void; + export function truncate(path: string, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function truncate(path: string, len: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function truncateSync(path: string, len?: number): void; + export function ftruncate(fd: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function ftruncate(fd: number, len: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function ftruncateSync(fd: number, len?: number): void; + export function chown(path: string, uid: number, gid: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function chownSync(path: string, uid: number, gid: number): void; + export function fchown(fd: number, uid: number, gid: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function fchownSync(fd: number, uid: number, gid: number): void; + export function lchown(path: string, uid: number, gid: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function lchownSync(path: string, uid: number, gid: number): void; + export function chmod(path: string, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function chmod(path: string, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function chmodSync(path: string, mode: number): void; + export function chmodSync(path: string, mode: string): void; + export function fchmod(fd: number, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function fchmod(fd: number, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function fchmodSync(fd: number, mode: number): void; + export function fchmodSync(fd: number, mode: string): void; + export function lchmod(path: string, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function lchmod(path: string, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function lchmodSync(path: string, mode: number): void; + export function lchmodSync(path: string, mode: string): void; + export function stat(path: string, callback?: (err: NodeJS.ErrnoException, stats: Stats) => any): void; + export function lstat(path: string, callback?: (err: NodeJS.ErrnoException, stats: Stats) => any): void; + export function fstat(fd: number, callback?: (err: NodeJS.ErrnoException, stats: Stats) => any): void; + export function statSync(path: string): Stats; + export function lstatSync(path: string): Stats; + export function fstatSync(fd: number): Stats; + export function link(srcpath: string, dstpath: string, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function linkSync(srcpath: string, dstpath: string): void; + export function symlink(srcpath: string, dstpath: string, type?: string, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function symlinkSync(srcpath: string, dstpath: string, type?: string): void; + export function readlink(path: string, callback?: (err: NodeJS.ErrnoException, linkString: string) => any): void; + export function readlinkSync(path: string): string; + export function realpath(path: string, callback?: (err: NodeJS.ErrnoException, resolvedPath: string) => any): void; + export function realpath(path: string, cache: {[path: string]: string}, callback: (err: NodeJS.ErrnoException, resolvedPath: string) =>any): void; + export function realpathSync(path: string, cache?: { [path: string]: string }): string; + /* + * Asynchronous unlink - deletes the file specified in {path} + * + * @param path + * @param callback No arguments other than a possible exception are given to the completion callback. + */ + export function unlink(path: string, callback?: (err?: NodeJS.ErrnoException) => void): void; + /* + * Synchronous unlink - deletes the file specified in {path} + * + * @param path + */ + export function unlinkSync(path: string): void; + /* + * Asynchronous rmdir - removes the directory specified in {path} + * + * @param path + * @param callback No arguments other than a possible exception are given to the completion callback. + */ + export function rmdir(path: string, callback?: (err?: NodeJS.ErrnoException) => void): void; + /* + * Synchronous rmdir - removes the directory specified in {path} + * + * @param path + */ + export function rmdirSync(path: string): void; + /* + * Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. + * + * @param path + * @param callback No arguments other than a possible exception are given to the completion callback. + */ + export function mkdir(path: string, callback?: (err?: NodeJS.ErrnoException) => void): void; + /* + * Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. + * + * @param path + * @param mode + * @param callback No arguments other than a possible exception are given to the completion callback. + */ + export function mkdir(path: string, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + /* + * Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. + * + * @param path + * @param mode + * @param callback No arguments other than a possible exception are given to the completion callback. + */ + export function mkdir(path: string, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void; + /* + * Synchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. + * + * @param path + * @param mode + * @param callback No arguments other than a possible exception are given to the completion callback. + */ + export function mkdirSync(path: string, mode?: number): void; + /* + * Synchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. + * + * @param path + * @param mode + * @param callback No arguments other than a possible exception are given to the completion callback. + */ + export function mkdirSync(path: string, mode?: string): void; + export function readdir(path: string, callback?: (err: NodeJS.ErrnoException, files: string[]) => void): void; + export function readdirSync(path: string): string[]; + export function close(fd: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function closeSync(fd: number): void; + export function open(path: string, flags: string, callback?: (err: NodeJS.ErrnoException, fd: number) => any): void; + export function open(path: string, flags: string, mode: number, callback?: (err: NodeJS.ErrnoException, fd: number) => any): void; + export function open(path: string, flags: string, mode: string, callback?: (err: NodeJS.ErrnoException, fd: number) => any): void; + export function openSync(path: string, flags: string, mode?: number): number; + export function openSync(path: string, flags: string, mode?: string): number; + export function utimes(path: string, atime: number, mtime: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function utimes(path: string, atime: Date, mtime: Date, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function utimesSync(path: string, atime: number, mtime: number): void; + export function utimesSync(path: string, atime: Date, mtime: Date): void; + export function futimes(fd: number, atime: number, mtime: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function futimes(fd: number, atime: Date, mtime: Date, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function futimesSync(fd: number, atime: number, mtime: number): void; + export function futimesSync(fd: number, atime: Date, mtime: Date): void; + export function fsync(fd: number, callback?: (err?: NodeJS.ErrnoException) => void): void; + export function fsyncSync(fd: number): void; + export function write(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void; + export function write(fd: number, buffer: Buffer, offset: number, length: number, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void; + export function write(fd: number, data: any, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; + export function write(fd: number, data: any, offset: number, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; + export function write(fd: number, data: any, offset: number, encoding: string, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; + export function writeSync(fd: number, buffer: Buffer, offset: number, length: number, position: number): number; + export function read(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: (err: NodeJS.ErrnoException, bytesRead: number, buffer: Buffer) => void): void; + export function readSync(fd: number, buffer: Buffer, offset: number, length: number, position: number): number; + /* + * Asynchronous readFile - Asynchronously reads the entire contents of a file. + * + * @param fileName + * @param encoding + * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file. + */ + export function readFile(filename: string, encoding: string, callback: (err: NodeJS.ErrnoException, data: string) => void): void; + /* + * Asynchronous readFile - Asynchronously reads the entire contents of a file. + * + * @param fileName + * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFile returns a string; otherwise it returns a Buffer. + * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file. + */ + export function readFile(filename: string, options: { encoding: string; flag?: string; }, callback: (err: NodeJS.ErrnoException, data: string) => void): void; + /* + * Asynchronous readFile - Asynchronously reads the entire contents of a file. + * + * @param fileName + * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFile returns a string; otherwise it returns a Buffer. + * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file. + */ + export function readFile(filename: string, options: { flag?: string; }, callback: (err: NodeJS.ErrnoException, data: Buffer) => void): void; + /* + * Asynchronous readFile - Asynchronously reads the entire contents of a file. + * + * @param fileName + * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file. + */ + export function readFile(filename: string, callback: (err: NodeJS.ErrnoException, data: Buffer) => void): void; + /* + * Synchronous readFile - Synchronously reads the entire contents of a file. + * + * @param fileName + * @param encoding + */ + export function readFileSync(filename: string, encoding: string): string; + /* + * Synchronous readFile - Synchronously reads the entire contents of a file. + * + * @param fileName + * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFileSync returns a string; otherwise it returns a Buffer. + */ + export function readFileSync(filename: string, options: { encoding: string; flag?: string; }): string; + /* + * Synchronous readFile - Synchronously reads the entire contents of a file. + * + * @param fileName + * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFileSync returns a string; otherwise it returns a Buffer. + */ + export function readFileSync(filename: string, options?: { flag?: string; }): Buffer; + export function writeFile(filename: string, data: any, callback?: (err: NodeJS.ErrnoException) => void): void; + export function writeFile(filename: string, data: any, options: { encoding?: string; mode?: number; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void; + export function writeFile(filename: string, data: any, options: { encoding?: string; mode?: string; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void; + export function writeFileSync(filename: string, data: any, options?: { encoding?: string; mode?: number; flag?: string; }): void; + export function writeFileSync(filename: string, data: any, options?: { encoding?: string; mode?: string; flag?: string; }): void; + export function appendFile(filename: string, data: any, options: { encoding?: string; mode?: number; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void; + export function appendFile(filename: string, data: any, options: { encoding?: string; mode?: string; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void; + export function appendFile(filename: string, data: any, callback?: (err: NodeJS.ErrnoException) => void): void; + export function appendFileSync(filename: string, data: any, options?: { encoding?: string; mode?: number; flag?: string; }): void; + export function appendFileSync(filename: string, data: any, options?: { encoding?: string; mode?: string; flag?: string; }): void; + export function watchFile(filename: string, listener: (curr: Stats, prev: Stats) => void): void; + export function watchFile(filename: string, options: { persistent?: boolean; interval?: number; }, listener: (curr: Stats, prev: Stats) => void): void; + export function unwatchFile(filename: string, listener?: (curr: Stats, prev: Stats) => void): void; + export function watch(filename: string, listener?: (event: string, filename: string) => any): FSWatcher; + export function watch(filename: string, options: { persistent?: boolean; }, listener?: (event: string, filename: string) => any): FSWatcher; + export function exists(path: string, callback?: (exists: boolean) => void): void; + export function existsSync(path: string): boolean; + /** Constant for fs.access(). File is visible to the calling process. */ + export var F_OK: number; + /** Constant for fs.access(). File can be read by the calling process. */ + export var R_OK: number; + /** Constant for fs.access(). File can be written by the calling process. */ + export var W_OK: number; + /** Constant for fs.access(). File can be executed by the calling process. */ + export var X_OK: number; + /** Tests a user's permissions for the file specified by path. */ + export function access(path: string, callback: (err: NodeJS.ErrnoException) => void): void; + export function access(path: string, mode: number, callback: (err: NodeJS.ErrnoException) => void): void; + /** Synchronous version of fs.access. This throws if any accessibility checks fail, and does nothing otherwise. */ + export function accessSync(path: string, mode ?: number): void; + export function createReadStream(path: string, options?: { + flags?: string; + encoding?: string; + fd?: number; + mode?: number; + autoClose?: boolean; + }): ReadStream; + export function createWriteStream(path: string, options?: { + flags?: string; + encoding?: string; + fd?: number; + mode?: number; + }): WriteStream; +} + +declare module "path" { + + /** + * A parsed path object generated by path.parse() or consumed by path.format(). + */ + export interface ParsedPath { + /** + * The root of the path such as '/' or 'c:\' + */ + root: string; + /** + * The full directory path such as '/home/user/dir' or 'c:\path\dir' + */ + dir: string; + /** + * The file name including extension (if any) such as 'index.html' + */ + base: string; + /** + * The file extension (if any) such as '.html' + */ + ext: string; + /** + * The file name without extension (if any) such as 'index' + */ + name: string; + } + + /** + * Normalize a string path, reducing '..' and '.' parts. + * When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used. + * + * @param p string path to normalize. + */ + export function normalize(p: string): string; + /** + * Join all arguments together and normalize the resulting path. + * Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown. + * + * @param paths string paths to join. + */ + export function join(...paths: any[]): string; + /** + * Join all arguments together and normalize the resulting path. + * Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown. + * + * @param paths string paths to join. + */ + export function join(...paths: string[]): string; + /** + * The right-most parameter is considered {to}. Other parameters are considered an array of {from}. + * + * Starting from leftmost {from} paramter, resolves {to} to an absolute path. + * + * If {to} isn't already absolute, {from} arguments are prepended in right to left order, until an absolute path is found. If after using all {from} paths still no absolute path is found, the current working directory is used as well. The resulting path is normalized, and trailing slashes are removed unless the path gets resolved to the root directory. + * + * @param pathSegments string paths to join. Non-string arguments are ignored. + */ + export function resolve(...pathSegments: any[]): string; + /** + * Determines whether {path} is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory. + * + * @param path path to test. + */ + export function isAbsolute(path: string): boolean; + /** + * Solve the relative path from {from} to {to}. + * At times we have two absolute paths, and we need to derive the relative path from one to the other. This is actually the reverse transform of path.resolve. + * + * @param from + * @param to + */ + export function relative(from: string, to: string): string; + /** + * Return the directory name of a path. Similar to the Unix dirname command. + * + * @param p the path to evaluate. + */ + export function dirname(p: string): string; + /** + * Return the last portion of a path. Similar to the Unix basename command. + * Often used to extract the file name from a fully qualified path. + * + * @param p the path to evaluate. + * @param ext optionally, an extension to remove from the result. + */ + export function basename(p: string, ext?: string): string; + /** + * Return the extension of the path, from the last '.' to end of string in the last portion of the path. + * If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string + * + * @param p the path to evaluate. + */ + export function extname(p: string): string; + /** + * The platform-specific file separator. '\\' or '/'. + */ + export var sep: string; + /** + * The platform-specific file delimiter. ';' or ':'. + */ + export var delimiter: string; + /** + * Returns an object from a path string - the opposite of format(). + * + * @param pathString path to evaluate. + */ + export function parse(pathString: string): ParsedPath; + /** + * Returns a path string from an object - the opposite of parse(). + * + * @param pathString path to evaluate. + */ + export function format(pathObject: ParsedPath): string; + + export module posix { + export function normalize(p: string): string; + export function join(...paths: any[]): string; + export function resolve(...pathSegments: any[]): string; + export function isAbsolute(p: string): boolean; + export function relative(from: string, to: string): string; + export function dirname(p: string): string; + export function basename(p: string, ext?: string): string; + export function extname(p: string): string; + export var sep: string; + export var delimiter: string; + export function parse(p: string): ParsedPath; + export function format(pP: ParsedPath): string; + } + + export module win32 { + export function normalize(p: string): string; + export function join(...paths: any[]): string; + export function resolve(...pathSegments: any[]): string; + export function isAbsolute(p: string): boolean; + export function relative(from: string, to: string): string; + export function dirname(p: string): string; + export function basename(p: string, ext?: string): string; + export function extname(p: string): string; + export var sep: string; + export var delimiter: string; + export function parse(p: string): ParsedPath; + export function format(pP: ParsedPath): string; + } +} + +declare module "string_decoder" { + export interface NodeStringDecoder { + write(buffer: Buffer): string; + detectIncompleteChar(buffer: Buffer): number; + } + export var StringDecoder: { + new (encoding: string): NodeStringDecoder; + }; +} + +declare module "tls" { + import * as crypto from "crypto"; + import * as net from "net"; + import * as stream from "stream"; + + var CLIENT_RENEG_LIMIT: number; + var CLIENT_RENEG_WINDOW: number; + + export interface TlsOptions { + host?: string; + port?: number; + pfx?: any; //string or buffer + key?: any; //string or buffer + passphrase?: string; + cert?: any; + ca?: any; //string or buffer + crl?: any; //string or string array + ciphers?: string; + honorCipherOrder?: any; + requestCert?: boolean; + rejectUnauthorized?: boolean; + NPNProtocols?: any; //array or Buffer; + SNICallback?: (servername: string) => any; + } + + export interface ConnectionOptions { + host?: string; + port?: number; + socket?: net.Socket; + pfx?: any; //string | Buffer + key?: any; //string | Buffer + passphrase?: string; + cert?: any; //string | Buffer + ca?: any; //Array of string | Buffer + rejectUnauthorized?: boolean; + NPNProtocols?: any; //Array of string | Buffer + servername?: string; + } + + export interface Server extends net.Server { + // Extended base methods + listen(port: number, host?: string, backlog?: number, listeningListener?: Function): Server; + listen(path: string, listeningListener?: Function): Server; + listen(handle: any, listeningListener?: Function): Server; + + listen(port: number, host?: string, callback?: Function): Server; + close(): Server; + address(): { port: number; family: string; address: string; }; + addContext(hostName: string, credentials: { + key: string; + cert: string; + ca: string; + }): void; + maxConnections: number; + connections: number; + } + + export interface ClearTextStream extends stream.Duplex { + authorized: boolean; + authorizationError: Error; + getPeerCertificate(): any; + getCipher: { + name: string; + version: string; + }; + address: { + port: number; + family: string; + address: string; + }; + remoteAddress: string; + remotePort: number; + } + + export interface SecurePair { + encrypted: any; + cleartext: any; + } + + export interface SecureContextOptions { + pfx?: any; //string | buffer + key?: any; //string | buffer + passphrase?: string; + cert?: any; // string | buffer + ca?: any; // string | buffer + crl?: any; // string | string[] + ciphers?: string; + honorCipherOrder?: boolean; + } + + export interface SecureContext { + context: any; + } + + export function createServer(options: TlsOptions, secureConnectionListener?: (cleartextStream: ClearTextStream) =>void ): Server; + export function connect(options: TlsOptions, secureConnectionListener?: () =>void ): ClearTextStream; + export function connect(port: number, host?: string, options?: ConnectionOptions, secureConnectListener?: () =>void ): ClearTextStream; + export function connect(port: number, options?: ConnectionOptions, secureConnectListener?: () =>void ): ClearTextStream; + export function createSecurePair(credentials?: crypto.Credentials, isServer?: boolean, requestCert?: boolean, rejectUnauthorized?: boolean): SecurePair; + export function createSecureContext(details: SecureContextOptions): SecureContext; +} + +declare module "crypto" { + export interface CredentialDetails { + pfx: string; + key: string; + passphrase: string; + cert: string; + ca: any; //string | string array + crl: any; //string | string array + ciphers: string; + } + export interface Credentials { context?: any; } + export function createCredentials(details: CredentialDetails): Credentials; + export function createHash(algorithm: string): Hash; + export function createHmac(algorithm: string, key: string): Hmac; + export function createHmac(algorithm: string, key: Buffer): Hmac; + export interface Hash { + update(data: any, input_encoding?: string): Hash; + digest(encoding: 'buffer'): Buffer; + digest(encoding: string): any; + digest(): Buffer; + } + export interface Hmac extends NodeJS.ReadWriteStream { + update(data: any, input_encoding?: string): Hmac; + digest(encoding: 'buffer'): Buffer; + digest(encoding: string): any; + digest(): Buffer; + } + export function createCipher(algorithm: string, password: any): Cipher; + export function createCipheriv(algorithm: string, key: any, iv: any): Cipher; + export interface Cipher { + update(data: Buffer): Buffer; + update(data: string, input_encoding?: string, output_encoding?: string): string; + final(): Buffer; + final(output_encoding: string): string; + setAutoPadding(auto_padding: boolean): void; + } + export function createDecipher(algorithm: string, password: any): Decipher; + export function createDecipheriv(algorithm: string, key: any, iv: any): Decipher; + export interface Decipher { + update(data: Buffer): Buffer; + update(data: string, input_encoding?: string, output_encoding?: string): string; + final(): Buffer; + final(output_encoding: string): string; + setAutoPadding(auto_padding: boolean): void; + } + export function createSign(algorithm: string): Signer; + export interface Signer extends NodeJS.WritableStream { + update(data: any): void; + sign(private_key: string, output_format: string): string; + } + export function createVerify(algorith: string): Verify; + export interface Verify extends NodeJS.WritableStream { + update(data: any): void; + verify(object: string, signature: string, signature_format?: string): boolean; + } + export function createDiffieHellman(prime_length: number): DiffieHellman; + export function createDiffieHellman(prime: number, encoding?: string): DiffieHellman; + export interface DiffieHellman { + generateKeys(encoding?: string): string; + computeSecret(other_public_key: string, input_encoding?: string, output_encoding?: string): string; + getPrime(encoding?: string): string; + getGenerator(encoding: string): string; + getPublicKey(encoding?: string): string; + getPrivateKey(encoding?: string): string; + setPublicKey(public_key: string, encoding?: string): void; + setPrivateKey(public_key: string, encoding?: string): void; + } + export function getDiffieHellman(group_name: string): DiffieHellman; + export function pbkdf2(password: string|Buffer, salt: string|Buffer, iterations: number, keylen: number, callback: (err: Error, derivedKey: Buffer) => any): void; + export function pbkdf2(password: string|Buffer, salt: string|Buffer, iterations: number, keylen: number, digest: string, callback: (err: Error, derivedKey: Buffer) => any): void; + export function pbkdf2Sync(password: string|Buffer, salt: string|Buffer, iterations: number, keylen: number) : Buffer; + export function pbkdf2Sync(password: string|Buffer, salt: string|Buffer, iterations: number, keylen: number, digest: string) : Buffer; + export function randomBytes(size: number): Buffer; + export function randomBytes(size: number, callback: (err: Error, buf: Buffer) =>void ): void; + export function pseudoRandomBytes(size: number): Buffer; + export function pseudoRandomBytes(size: number, callback: (err: Error, buf: Buffer) =>void ): void; +} + +declare module "stream" { + import * as events from "events"; + + export class Stream extends events.EventEmitter { + pipe(destination: T, options?: { end?: boolean; }): T; + } + + export interface ReadableOptions { + highWaterMark?: number; + encoding?: string; + objectMode?: boolean; + } + + export class Readable extends events.EventEmitter implements NodeJS.ReadableStream { + readable: boolean; + constructor(opts?: ReadableOptions); + _read(size: number): void; + read(size?: number): any; + setEncoding(encoding: string): void; + pause(): void; + resume(): void; + pipe(destination: T, options?: { end?: boolean; }): T; + unpipe(destination?: T): void; + unshift(chunk: any): void; + wrap(oldStream: NodeJS.ReadableStream): NodeJS.ReadableStream; + push(chunk: any, encoding?: string): boolean; + } + + export interface WritableOptions { + highWaterMark?: number; + decodeStrings?: boolean; + objectMode?: boolean; + } + + export class Writable extends events.EventEmitter implements NodeJS.WritableStream { + writable: boolean; + constructor(opts?: WritableOptions); + _write(chunk: any, encoding: string, callback: Function): void; + write(chunk: any, cb?: Function): boolean; + write(chunk: any, encoding?: string, cb?: Function): boolean; + end(): void; + end(chunk: any, cb?: Function): void; + end(chunk: any, encoding?: string, cb?: Function): void; + } + + export interface DuplexOptions extends ReadableOptions, WritableOptions { + allowHalfOpen?: boolean; + } + + // Note: Duplex extends both Readable and Writable. + export class Duplex extends Readable implements NodeJS.ReadWriteStream { + writable: boolean; + constructor(opts?: DuplexOptions); + _write(chunk: any, encoding: string, callback: Function): void; + write(chunk: any, cb?: Function): boolean; + write(chunk: any, encoding?: string, cb?: Function): boolean; + end(): void; + end(chunk: any, cb?: Function): void; + end(chunk: any, encoding?: string, cb?: Function): void; + } + + export interface TransformOptions extends ReadableOptions, WritableOptions {} + + // Note: Transform lacks the _read and _write methods of Readable/Writable. + export class Transform extends events.EventEmitter implements NodeJS.ReadWriteStream { + readable: boolean; + writable: boolean; + constructor(opts?: TransformOptions); + _transform(chunk: any, encoding: string, callback: Function): void; + _flush(callback: Function): void; + read(size?: number): any; + setEncoding(encoding: string): void; + pause(): void; + resume(): void; + pipe(destination: T, options?: { end?: boolean; }): T; + unpipe(destination?: T): void; + unshift(chunk: any): void; + wrap(oldStream: NodeJS.ReadableStream): NodeJS.ReadableStream; + push(chunk: any, encoding?: string): boolean; + write(chunk: any, cb?: Function): boolean; + write(chunk: any, encoding?: string, cb?: Function): boolean; + end(): void; + end(chunk: any, cb?: Function): void; + end(chunk: any, encoding?: string, cb?: Function): void; + } + + export class PassThrough extends Transform {} +} + +declare module "util" { + export interface InspectOptions { + showHidden?: boolean; + depth?: number; + colors?: boolean; + customInspect?: boolean; + } + + export function format(format: any, ...param: any[]): string; + export function debug(string: string): void; + export function error(...param: any[]): void; + export function puts(...param: any[]): void; + export function print(...param: any[]): void; + export function log(string: string): void; + export function inspect(object: any, showHidden?: boolean, depth?: number, color?: boolean): string; + export function inspect(object: any, options: InspectOptions): string; + export function isArray(object: any): boolean; + export function isRegExp(object: any): boolean; + export function isDate(object: any): boolean; + export function isError(object: any): boolean; + export function inherits(constructor: any, superConstructor: any): void; + export function debuglog(key:string): (msg:string,...param: any[])=>void; +} + +declare module "assert" { + function internal (value: any, message?: string): void; + module internal { + export class AssertionError implements Error { + name: string; + message: string; + actual: any; + expected: any; + operator: string; + generatedMessage: boolean; + + constructor(options?: {message?: string; actual?: any; expected?: any; + operator?: string; stackStartFunction?: Function}); + } + + export function fail(actual?: any, expected?: any, message?: string, operator?: string): void; + export function ok(value: any, message?: string): void; + export function equal(actual: any, expected: any, message?: string): void; + export function notEqual(actual: any, expected: any, message?: string): void; + export function deepEqual(actual: any, expected: any, message?: string): void; + export function notDeepEqual(acutal: any, expected: any, message?: string): void; + export function strictEqual(actual: any, expected: any, message?: string): void; + export function notStrictEqual(actual: any, expected: any, message?: string): void; + export function deepStrictEqual(actual: any, expected: any, message?: string): void; + export function notDeepStrictEqual(actual: any, expected: any, message?: string): void; + export var throws: { + (block: Function, message?: string): void; + (block: Function, error: Function, message?: string): void; + (block: Function, error: RegExp, message?: string): void; + (block: Function, error: (err: any) => boolean, message?: string): void; + }; + + export var doesNotThrow: { + (block: Function, message?: string): void; + (block: Function, error: Function, message?: string): void; + (block: Function, error: RegExp, message?: string): void; + (block: Function, error: (err: any) => boolean, message?: string): void; + }; + + export function ifError(value: any): void; + } + + export = internal; +} + +declare module "tty" { + import * as net from "net"; + + export function isatty(fd: number): boolean; + export interface ReadStream extends net.Socket { + isRaw: boolean; + setRawMode(mode: boolean): void; + isTTY: boolean; + } + export interface WriteStream extends net.Socket { + columns: number; + rows: number; + isTTY: boolean; + } +} + +declare module "domain" { + import * as events from "events"; + + export class Domain extends events.EventEmitter { + run(fn: Function): void; + add(emitter: events.EventEmitter): void; + remove(emitter: events.EventEmitter): void; + bind(cb: (err: Error, data: any) => any): any; + intercept(cb: (data: any) => any): any; + dispose(): void; + + addListener(event: string, listener: Function): Domain; + on(event: string, listener: Function): Domain; + once(event: string, listener: Function): Domain; + removeListener(event: string, listener: Function): Domain; + removeAllListeners(event?: string): Domain; + } + + export function create(): Domain; +} + +declare module "constants" { + export var E2BIG: number; + export var EACCES: number; + export var EADDRINUSE: number; + export var EADDRNOTAVAIL: number; + export var EAFNOSUPPORT: number; + export var EAGAIN: number; + export var EALREADY: number; + export var EBADF: number; + export var EBADMSG: number; + export var EBUSY: number; + export var ECANCELED: number; + export var ECHILD: number; + export var ECONNABORTED: number; + export var ECONNREFUSED: number; + export var ECONNRESET: number; + export var EDEADLK: number; + export var EDESTADDRREQ: number; + export var EDOM: number; + export var EEXIST: number; + export var EFAULT: number; + export var EFBIG: number; + export var EHOSTUNREACH: number; + export var EIDRM: number; + export var EILSEQ: number; + export var EINPROGRESS: number; + export var EINTR: number; + export var EINVAL: number; + export var EIO: number; + export var EISCONN: number; + export var EISDIR: number; + export var ELOOP: number; + export var EMFILE: number; + export var EMLINK: number; + export var EMSGSIZE: number; + export var ENAMETOOLONG: number; + export var ENETDOWN: number; + export var ENETRESET: number; + export var ENETUNREACH: number; + export var ENFILE: number; + export var ENOBUFS: number; + export var ENODATA: number; + export var ENODEV: number; + export var ENOENT: number; + export var ENOEXEC: number; + export var ENOLCK: number; + export var ENOLINK: number; + export var ENOMEM: number; + export var ENOMSG: number; + export var ENOPROTOOPT: number; + export var ENOSPC: number; + export var ENOSR: number; + export var ENOSTR: number; + export var ENOSYS: number; + export var ENOTCONN: number; + export var ENOTDIR: number; + export var ENOTEMPTY: number; + export var ENOTSOCK: number; + export var ENOTSUP: number; + export var ENOTTY: number; + export var ENXIO: number; + export var EOPNOTSUPP: number; + export var EOVERFLOW: number; + export var EPERM: number; + export var EPIPE: number; + export var EPROTO: number; + export var EPROTONOSUPPORT: number; + export var EPROTOTYPE: number; + export var ERANGE: number; + export var EROFS: number; + export var ESPIPE: number; + export var ESRCH: number; + export var ETIME: number; + export var ETIMEDOUT: number; + export var ETXTBSY: number; + export var EWOULDBLOCK: number; + export var EXDEV: number; + export var WSAEINTR: number; + export var WSAEBADF: number; + export var WSAEACCES: number; + export var WSAEFAULT: number; + export var WSAEINVAL: number; + export var WSAEMFILE: number; + export var WSAEWOULDBLOCK: number; + export var WSAEINPROGRESS: number; + export var WSAEALREADY: number; + export var WSAENOTSOCK: number; + export var WSAEDESTADDRREQ: number; + export var WSAEMSGSIZE: number; + export var WSAEPROTOTYPE: number; + export var WSAENOPROTOOPT: number; + export var WSAEPROTONOSUPPORT: number; + export var WSAESOCKTNOSUPPORT: number; + export var WSAEOPNOTSUPP: number; + export var WSAEPFNOSUPPORT: number; + export var WSAEAFNOSUPPORT: number; + export var WSAEADDRINUSE: number; + export var WSAEADDRNOTAVAIL: number; + export var WSAENETDOWN: number; + export var WSAENETUNREACH: number; + export var WSAENETRESET: number; + export var WSAECONNABORTED: number; + export var WSAECONNRESET: number; + export var WSAENOBUFS: number; + export var WSAEISCONN: number; + export var WSAENOTCONN: number; + export var WSAESHUTDOWN: number; + export var WSAETOOMANYREFS: number; + export var WSAETIMEDOUT: number; + export var WSAECONNREFUSED: number; + export var WSAELOOP: number; + export var WSAENAMETOOLONG: number; + export var WSAEHOSTDOWN: number; + export var WSAEHOSTUNREACH: number; + export var WSAENOTEMPTY: number; + export var WSAEPROCLIM: number; + export var WSAEUSERS: number; + export var WSAEDQUOT: number; + export var WSAESTALE: number; + export var WSAEREMOTE: number; + export var WSASYSNOTREADY: number; + export var WSAVERNOTSUPPORTED: number; + export var WSANOTINITIALISED: number; + export var WSAEDISCON: number; + export var WSAENOMORE: number; + export var WSAECANCELLED: number; + export var WSAEINVALIDPROCTABLE: number; + export var WSAEINVALIDPROVIDER: number; + export var WSAEPROVIDERFAILEDINIT: number; + export var WSASYSCALLFAILURE: number; + export var WSASERVICE_NOT_FOUND: number; + export var WSATYPE_NOT_FOUND: number; + export var WSA_E_NO_MORE: number; + export var WSA_E_CANCELLED: number; + export var WSAEREFUSED: number; + export var SIGHUP: number; + export var SIGINT: number; + export var SIGILL: number; + export var SIGABRT: number; + export var SIGFPE: number; + export var SIGKILL: number; + export var SIGSEGV: number; + export var SIGTERM: number; + export var SIGBREAK: number; + export var SIGWINCH: number; + export var SSL_OP_ALL: number; + export var SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION: number; + export var SSL_OP_CIPHER_SERVER_PREFERENCE: number; + export var SSL_OP_CISCO_ANYCONNECT: number; + export var SSL_OP_COOKIE_EXCHANGE: number; + export var SSL_OP_CRYPTOPRO_TLSEXT_BUG: number; + export var SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS: number; + export var SSL_OP_EPHEMERAL_RSA: number; + export var SSL_OP_LEGACY_SERVER_CONNECT: number; + export var SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER: number; + export var SSL_OP_MICROSOFT_SESS_ID_BUG: number; + export var SSL_OP_MSIE_SSLV2_RSA_PADDING: number; + export var SSL_OP_NETSCAPE_CA_DN_BUG: number; + export var SSL_OP_NETSCAPE_CHALLENGE_BUG: number; + export var SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG: number; + export var SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG: number; + export var SSL_OP_NO_COMPRESSION: number; + export var SSL_OP_NO_QUERY_MTU: number; + export var SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION: number; + export var SSL_OP_NO_SSLv2: number; + export var SSL_OP_NO_SSLv3: number; + export var SSL_OP_NO_TICKET: number; + export var SSL_OP_NO_TLSv1: number; + export var SSL_OP_NO_TLSv1_1: number; + export var SSL_OP_NO_TLSv1_2: number; + export var SSL_OP_PKCS1_CHECK_1: number; + export var SSL_OP_PKCS1_CHECK_2: number; + export var SSL_OP_SINGLE_DH_USE: number; + export var SSL_OP_SINGLE_ECDH_USE: number; + export var SSL_OP_SSLEAY_080_CLIENT_DH_BUG: number; + export var SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG: number; + export var SSL_OP_TLS_BLOCK_PADDING_BUG: number; + export var SSL_OP_TLS_D5_BUG: number; + export var SSL_OP_TLS_ROLLBACK_BUG: number; + export var ENGINE_METHOD_DSA: number; + export var ENGINE_METHOD_DH: number; + export var ENGINE_METHOD_RAND: number; + export var ENGINE_METHOD_ECDH: number; + export var ENGINE_METHOD_ECDSA: number; + export var ENGINE_METHOD_CIPHERS: number; + export var ENGINE_METHOD_DIGESTS: number; + export var ENGINE_METHOD_STORE: number; + export var ENGINE_METHOD_PKEY_METHS: number; + export var ENGINE_METHOD_PKEY_ASN1_METHS: number; + export var ENGINE_METHOD_ALL: number; + export var ENGINE_METHOD_NONE: number; + export var DH_CHECK_P_NOT_SAFE_PRIME: number; + export var DH_CHECK_P_NOT_PRIME: number; + export var DH_UNABLE_TO_CHECK_GENERATOR: number; + export var DH_NOT_SUITABLE_GENERATOR: number; + export var NPN_ENABLED: number; + export var RSA_PKCS1_PADDING: number; + export var RSA_SSLV23_PADDING: number; + export var RSA_NO_PADDING: number; + export var RSA_PKCS1_OAEP_PADDING: number; + export var RSA_X931_PADDING: number; + export var RSA_PKCS1_PSS_PADDING: number; + export var POINT_CONVERSION_COMPRESSED: number; + export var POINT_CONVERSION_UNCOMPRESSED: number; + export var POINT_CONVERSION_HYBRID: number; + export var O_RDONLY: number; + export var O_WRONLY: number; + export var O_RDWR: number; + export var S_IFMT: number; + export var S_IFREG: number; + export var S_IFDIR: number; + export var S_IFCHR: number; + export var S_IFLNK: number; + export var O_CREAT: number; + export var O_EXCL: number; + export var O_TRUNC: number; + export var O_APPEND: number; + export var F_OK: number; + export var R_OK: number; + export var W_OK: number; + export var X_OK: number; + export var UV_UDP_REUSEADDR: number; +} \ No newline at end of file From 9e9f7bedf757a1b99e38bf6f56e79123444d7a8e Mon Sep 17 00:00:00 2001 From: Richard Natal Date: Mon, 1 Feb 2016 18:12:47 -0200 Subject: [PATCH 3/5] Updated references to node.d.ts --- index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.d.ts b/index.d.ts index c8e05fc14..2e7cbd6e4 100644 --- a/index.d.ts +++ b/index.d.ts @@ -3,7 +3,7 @@ // Definitions by: Richard Natal // Definitions: https://github.com/oracle/node-oracledb -/// +/// declare module 'oracledb' { import * as stream from "stream"; From 7d89ed66ee07cac53daa23a83b177211c932a9ce Mon Sep 17 00:00:00 2001 From: Richard Natal Date: Wed, 27 Jul 2016 14:28:21 -0300 Subject: [PATCH 4/5] Upgraded typescript definitions file. Signed-off-by: Richard Natal --- index.d.ts | 645 +++++++++++++++++++++++++++++------------------------ 1 file changed, 357 insertions(+), 288 deletions(-) diff --git a/index.d.ts b/index.d.ts index 2e7cbd6e4..dcfebb086 100644 --- a/index.d.ts +++ b/index.d.ts @@ -1,27 +1,26 @@ -// Type definitions for oracledb v1.6.0 +// Type definitions for oracledb v1.10.0 // Project: https://github.com/oracle/node-oracledb // Definitions by: Richard Natal -// Definitions: https://github.com/oracle/node-oracledb +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -/// +/// declare module 'oracledb' { import * as stream from "stream"; + export type TRet = T | IPromise; + export type TFunc = (value: T) => TRet; + + export interface IPromise { + catch(onReject: TFunc) : IPromise; + then(onResolve?: TFunc, onReject?: TFunc) : IPromise; + } + export interface ILob { - /** [Read-Only] This corresponds to the size used by the Oracle LOB layer when accessing or modifying the LOB value. */ chunkSize: number; - /** [Read-Only] Length of a queried LOB in bytes (for BLOBs) or characters (for CLOBs). */ length: number; - /** - * The number of bytes (for BLOBs) or characters (for CLOBs) to read for each Stream 'data' event of a queried LOB. - * The default value is chunkSize. - * For efficiency, it is recommended that pieceSize be a multiple of chunkSize. - * The maximum value for pieceSize is limited to the value of UINT_MAX. - */ pieceSize: number; offset?: number; - /** [Read-Only] This read-only attribute shows the type of Lob being used. It will have the value of one of the constants Oracledb.BLOB or Oracledb.CLOB. The value is derived from the bind type when using LOB bind variables, or from the column type when a LOB is returned by a query. */ type: string; /** * Release method on ILob class. @@ -45,21 +44,22 @@ declare module 'oracledb' { } export interface Lob extends stream.Duplex { - /** Internal - do not use it. */ iLob: ILob; - /** [Read-Only] This corresponds to the size used by the Oracle LOB layer when accessing or modifying the LOB value. */ + /** This corresponds to the size used by the Oracle LOB layer when accessing or modifying the LOB value. */ chunkSize: number; - /** [Read-Only] Length of a queried LOB in bytes (for BLOBs) or characters (for CLOBs). */ + /** Length of a queried LOB in bytes (for BLOBs) or characters (for CLOBs). */ length: number; /** - * The number of bytes (for BLOBs) or characters (for CLOBs) to read for each Stream 'data' event of a queried LOB. + * he number of bytes (for BLOBs) or characters (for CLOBs) to read for each Stream 'data' event of a queried LOB. * The default value is chunkSize. * For efficiency, it is recommended that pieceSize be a multiple of chunkSize. * The maximum value for pieceSize is limited to the value of UINT_MAX. */ pieceSize: number; - /** [Read-Only] This read-only attribute shows the type of Lob being used. It will have the value of one of the constants Oracledb.BLOB or Oracledb.CLOB. The value is derived from the bind type when using LOB bind variables, or from the column type when a LOB is returned by a query. */ - type: string; + /** + * This read-only attribute shows the type of Lob being used. It will have the value of one of the constants Oracledb.BLOB or Oracledb.CLOB. The value is derived from the bind type when using LOB bind variables, or from the column type when a LOB is returned by a query. + */ + type: number; /** * Do not call this... used internally by node-oracledb @@ -77,141 +77,121 @@ declare module 'oracledb' { } export interface IConnectionAttributes { - /** - * The database user name. Can be a simple user name or a proxy of the form alison[fred]. See the Client Access Through Proxy section in the OCI manual for more details about proxy authentication. - */ user?: string; - /** - * The password of the database user. A password is also necessary if a proxy user is specified. - */ password?: string; - /** - * The Oracle database instance to connect to. The string can be an Easy Connect string, or a Net Service Name from a tnsnames.ora file, or the name of a local Oracle database instance. - */ connectString: string; - /** - * The number of statements to be cached in the statement cache of each connection. This optional property may be used to override the stmtCacheSize property of the Oracledb object. - */ stmtCacheSize?: number; - /** - * If this optional property is true then the pool's connections will be established using External Authentication. - * This property overrides the Oracledb externalAuth property. - * The user and password properties should not be set when externalAuth is true. - * Note prior to node-oracledb 0.5 this property was called isExternalAuth. - */ externalAuth?: boolean; } - /** - * Provides connection credentials and pool-specific configuration properties, such as the maximum or minimum number of connections for the pool, or stmtCacheSize for the connections. The properties provided in the poolAttrs parameter override the default pooling properties in effect in the Oracledb object. - */ export interface IPoolAttributes extends IConnectionAttributes { - /** - * The maximum number of connections to which a connection pool can grow. - * This optional property may be used to override the corresponding property in the Oracledb object. - */ poolMax?: number; - /** - * The minimum number of connections a connection pool maintains, even when there is no activity to the target database. This optional property may be used to override the corresponding property in the Oracledb object. - */ poolMin?: number; - /** - * The number of connections that are opened whenever a connection request exceeds the number of currently open connections. This optional property may be used to override the corresponding property in the Oracledb object. - */ poolIncrement?: number; - /** - * The number of seconds after which idle connections (unused in the pool) may be terminated. Idle connections are terminated only when the pool is accessed. If the poolTimeout is set to 0, then idle connections are never terminated. - * This optional property may be used to override the corresponding property in the Oracledb object. - */ poolTimeout?: number; } - /** - * This execute() function parameter is needed if there are bind variables in the statement, or if options are used. It can be either an object that associates values or JavaScript variables to the statement's bind variables by name, or an array of values or JavaScript variables that associate to the statement's bind variables by their relative positions. - */ - export interface IExecutionBinds { - /** - * The direction of the bind. One of the Oracledb Constants BIND_IN, BIND_INOUT, or BIND_OUT. - */ - dir?: number; - /** - * The number of array elements to be allocated for a PL/SQL Collection INDEX OF associative array OUT or IN OUT array bind variable. - */ - maxArraySize?: number; - /** - * The maximum number of bytes that an OUT or IN OUT bind variable of type STRING or BUFFER can use. The default value is 200. The maximum limit is 32767. - */ - maxSize?: number; + export interface IExecuteOptions { /** - * The datatype to be bound. One of the Oracledb Constants STRING, NUMBER, DATE, CURSOR or BUFFER. + * Transaction should auto commit after each statement? + * Overrides Oracledb autoCommit. */ - type?: number; + autoCommit?: boolean; /** - * The input value or variable to be used for an IN or IN OUT bind variable. + * Determines whether additional metadata is available for queries and for REF CURSORs returned from PL/SQL blocks. + * Overrides Oracledb extendedMetaData. */ - val?: any; - } - - export interface IExecuteOptions { - /** Maximum number of rows that will be retrieved. Used when resultSet is false. */ - maxRows?: number; - /** Number of rows to be fetched in advance. */ - prefetchRows?: number; - /** Result format - ARRAY o OBJECT */ - outFormat?: number; - /** Should use ResultSet or not. */ - resultSet?: boolean; - /** Transaction should auto commit after each statement? */ - autoCommit?: boolean; + extendedMetaData?: boolean; /** * Object defining how query column data should be represented in JavaScript. * The fetchInfo property can be used to indicate that number or date columns in a query should be returned as strings instead of their native format. The property can be used in conjunction with, or instead of, the global setting fetchAsString. - * * For example: - * + * * fetchInfo: * { * "HIRE_DATE": { type : oracledb.STRING }, // return the date as a string * "COMMISSION_PCT": { type : oracledb.DEFAULT } // override Oracledb.fetchAsString * } + * + * Each column is specified by name, using Oracle's standard naming convention. + * The valid values for type are STRING and DEFAULT. The former indicates that the given column should be returned as a string. The latter can be used to override any global mapping given by fetchAsString and allow the column data for this query to be returned in native format. + * The maximum length of a string created by type mapping is 200 bytes. However, if a database column that is already of type STRING is specified in fetchInfo, then the actual database metadata will be used to determine the maximum length. + * Columns fetched from REF CURSORS are not mapped by fetchInfo settings in the execute() call. Use the global fetchAsString instead. */ fetchInfo?: Object; + /** + * Maximum number of rows that will be retrieved. Used when resultSet is false. + * Overrides Oracledb maxRows. + */ + maxRows?: number; + /** + * Result format - ARRAY o OBJECT + * Overrides Oracledb outFormat. + */ + outFormat?: number; + /** + * Number of rows to be fetched in advance. + * Overrides Oracledb prefetchRows. + */ + prefetchRows?: number; + /** + * Determines whether query results should be returned as a ResultSet object or directly. The default is false. + */ + resultSet?: boolean; } export interface IExecuteReturn { - /** Number o rows affected by the statement (used for inserts / updates)*/ - rowsAffected?: number; - /** When the statement has out parameters, it comes here. */ - outBinds?: Array | Object; - /** Metadata information - just columns names for now. */ + /** Metadata information - column names is always given. If the Oracledb extendedMetaData or execute() option extendedMetaData are true then additional information is included. */ metaData?: Array; - /** When not using ResultSet, query results comes here. */ - rows?: Array> | Array; - /** When using ResultSet, query results comes here. */ + /** This is either an array or an object containing OUT and IN OUT bind values. If bindParams is passed as an array, then outBinds is returned as an array. If bindParams is passed as an object, then outBinds is returned as an object. */ + outBinds?: Array | Object; + /** For SELECT statements when the resultSet option is true, use the resultSet object to fetch rows. See ResultSet Class. */ resultSet?: IResultSet; + /** For SELECT statements where the resultSet option is false or unspecified, rows contains an array of fetched rows. It will be NULL if there is an error or the SQL statement was not a SELECT statement. By default, the rows are in an array of column value arrays, but this can be changed to arrays of objects by setting outFormat to OBJECT. If a single row is fetched, then rows is an array that contains one single row. The number of rows returned is limited to the maxRows configuration property of the Oracledb object, although this may be overridden in any execute() call. */ + rows?: Array> | Array; + /** For DML statements (including SELECT FOR UPDATE) this contains the number of rows affected, for example the number of rows inserted. For non-DML statements such as queries, or if no rows are affected, then rowsAffected will be zero. */ + rowsAffected?: number; } export interface IMetaData { - /** Column name */ - columnName: string; + /** The column name follows Oracle's standard name-casing rules. It will commonly be uppercase, since most applications create tables using unquoted, case-insensitive names. */ + name: string; + /** one of the Node-oracledb Type Constant values. */ + fetchType?: number; + /** one of the Node-oracledb Type Constant values. */ + dbType?: number; + /** the database byte size. This is only set for DB_TYPE_VARCHAR, DB_TYPE_CHAR and DB_TYPE_RAW column types. */ + byteSize?: number; + /** set only for DB_TYPE_NUMBER, DB_TYPE_TIMESTAMP, DB_TYPE_TIMESTAMP_TZ and DB_TYPE_TIMESTAMP_LTZ columns. */ + precision?: number; + /** set only for DB_TYPE_NUMBER columns. */ + scale: number; + /** indicates whether NULL values are permitted for this column. */ + nullable?: boolean; } - /** - * Result sets allow query results to fetched from the database one at a time, or in groups of rows. This enables applications to process very large data sets. - * Result sets should also be used where the number of query rows cannot be predicted and may be larger than a sensible maxRows size. - * A ResultSet object is obtained by setting resultSet: true in the options parameter of the Connection execute() method when executing a query. A ResultSet is also returned to node-oracledb when binding as type CURSOR to a PL/SQL REF CURSOR bind parameter. - * The value of prefetchRows can be adjusted to tune the performance of result sets. - */ export interface IResultSet { - /** Metadata information - just columns names for now. */ + /** + * Contains an array of objects with metadata about the query or REF CURSOR columns. + * Each column's name is always given. If the Oracledb extendedMetaData or execute() option extendedMetaData are true then additional information is included. + */ metaData?: Array; + /** * Closes a ResultSet. Applications should always call this at the end of fetch or when no more rows are needed. - * @param {(err:any)=>void} callback Callback called on finish or when some error occurs + * @param {(err:any)=>void} callback Callback called on finish or when some error occurs. * @returns void - * @remarks After using a resultSet, it must be closed to free the resources used by the driver. + * @remarks Applications should always call this at the end of fetch or when no more rows are needed. */ close(callback: (err: any) => void): void; + + /** + * Closes a ResultSet. Applications should always call this at the end of fetch or when no more rows are needed. + * @returns A void Promise on finish or when some error occurs. + * @remarks Applications should always call this at the end of fetch or when no more rows are needed. + */ + close(): IPromise; + /** * This call fetches one row of the result set as an object or an array of column values, depending on the value of outFormat. * At the end of fetching, the ResultSet should be freed by calling close(). @@ -219,20 +199,28 @@ declare module 'oracledb' { * @returns void */ getRow(callback: (err: any, row: Array | Object) => void): void; + /** - * This call fetches numRows rows of the result set as an object or an array of column values, depending on the value of outFormat. + * This call fetches one row of the result set as an object or an array of column values, depending on the value of outFormat. * At the end of fetching, the ResultSet should be freed by calling close(). - * @param {number} rowCount Number of rows to be fetched. - * @param {(err:any,rows:Array>|Array)=>void} callback Callback called when the rows are available, or when some error occurs. - * @returns void - * @remarks When the number of rows passed to the callback is less than the rowCount, no more rows are available to be fetched. + * @returns Promise when the row is available or when some error occurs. + */ + getRow(): IPromise | Object>; + + /** + * This synchronous method converts a ResultSet into a stream. + * It can be used to make ResultSets from top-level queries or from REF CURSOR bind variables streamable. To make top-level queries streamable, the alternative connection.queryStream() method may be easier to use. + * @returns synchronous stream of result set. */ - getRows(rowCount: number, callback: (err: any, rows: Array> | Array) => void): void; + toQueryStream(): stream.Readable; } export interface IConnection { - /** Statement cache size in bytes (read-only)*/ - stmtCacheSize: number; + /** + * The action attribute for end-to-end application tracing. + * This is a write-only property. Displaying a Connection object will show a value of null for this attribute. See End-to-end Tracing, Mid-tier Authentication, and Auditing. + */ + action: string; /** * The client identifier for end-to-end application tracing, use with mid-tier authentication, and with Virtual Private Databases. * This is a write-only property. Displaying a Connection object will show a value of null for this attribute. See End-to-end Tracing, Mid-tier Authentication, and Auditing. @@ -243,133 +231,269 @@ declare module 'oracledb' { * This is a write-only property. Displaying a Connection object will show a value of null for this attribute. See End-to-end Tracing, Mid-tier Authentication, and Auditing. */ module: string; - /** - * The action attribute for end-to-end application tracing. - * This is a write-only property. Displaying a Connection object will show a value of null for this attribute. See End-to-end Tracing, Mid-tier Authentication, and Auditing. - */ - action: string; /** * This readonly property gives a numeric representation of the Oracle database version. For version a.b.c.d.e, this property gives the number: (100000000 * a) + (1000000 * b) + (10000 * c) + (100 * d) + e */ oracleServerVersion: number; + /** + * The number of statements to be cached in the statement cache of the connection. The default value is the stmtCacheSize property in effect in the Pool object when the connection is created in the pool. + */ + stmtCacheSize: number; + + /** + * This call stops the currently running operation on the connection. + * If there is no operation in progress or the operation has completed by the time the break is issued, the break() is effectively a no-op. + * If the running asynchronous operation is interrupted, its callback will return an error. + * @param {(err: any) => void} callback Callback on break done. + */ + break(callback: (err: any) => void): void; + + /** + * This call stops the currently running operation on the connection. + * If there is no operation in progress or the operation has completed by the time the break is issued, the break() is effectively a no-op. + * If the running asynchronous operation is interrupted, its callback will return an error. + * @returns A void promise when break is done. + */ + break(): IPromise; + + /** + * Releases a connection. If the connection was obtained from the pool, the connection is returned to the pool and is available for reuse. + * Note: calling close() when connections are no longer required is strongly encouraged. Releasing helps avoid resource leakage and can improve system efficiency. + * When a connection is released, any ongoing transaction on the connection is rolled back. + * After releasing a connection to a pool, there is no guarantee a subsequent getConnection() call gets back the same database connection. The application must redo any ALTER SESSION statements on the new connection object, as required. + * @param {(err: any) => void} callback Callback on close done. + */ + close(callback: (err: any) => void): void; + + /** + * Releases a connection. If the connection was obtained from the pool, the connection is returned to the pool and is available for reuse. + * Note: calling close() when connections are no longer required is strongly encouraged. Releasing helps avoid resource leakage and can improve system efficiency. + * When a connection is released, any ongoing transaction on the connection is rolled back. + * After releasing a connection to a pool, there is no guarantee a subsequent getConnection() call gets back the same database connection. The application must redo any ALTER SESSION statements on the new connection object, as required. + * @returns A void Promise on close done. + */ + close(): IPromise; + + /** + * Send a commit requisition to the database. + * @param {(err: any) => void} callback Callback on commit done. + */ + commit(callback: (err: any) => void): void; + + /** + * Send a commit requisition to the database. + * @returns A void Promise on commit done. + */ + commit(): IPromise; + + /** + * This call executes a SQL or PL/SQL statement. See SQL Execution for examples. + * The statement to be executed may contain IN binds, OUT or IN OUT bind values or variables, which are bound using either an object or an array. + * A callback function returns a result object, containing any fetched rows, the values of any OUT and IN OUT bind variables, and the number of rows affected by the execution of DML statements. + * @param {string} sql SQL Statement. + * @param {Object|Array} bindParams Binds Object/Array + * @param {IExecuteOptions} options Options object + * @param {(err: any, value: IExecuteReturn) => void} callback Callback function to receive the result. + */ + execute(sql: string, + bindParams: Object | Array, + options: IExecuteOptions, + callback: (err: any, value: IExecuteReturn) => void): void; + + /** + * This call executes a SQL or PL/SQL statement. See SQL Execution for examples. + * The statement to be executed may contain IN binds, OUT or IN OUT bind values or variables, which are bound using either an object or an array. + * A callback function returns a result object, containing any fetched rows, the values of any OUT and IN OUT bind variables, and the number of rows affected by the execution of DML statements. + * @param {string} sql SQL Statement. + * @param {Object|Array} bindParams Binds Object/Array + * @param {(err: any, value: IExecuteReturn) => void} callback Callback function to receive the result. + */ + execute(sql: string, + bindParams: Object | Array, + callback: (err: any, value: IExecuteReturn) => void): void; /** * This call executes a SQL or PL/SQL statement. See SQL Execution for examples. - * This is an asynchronous call. * The statement to be executed may contain IN binds, OUT or IN OUT bind values or variables, which are bound using either an object or an array. * A callback function returns a result object, containing any fetched rows, the values of any OUT and IN OUT bind variables, and the number of rows affected by the execution of DML statements. - * @param {string} sql The SQL string that is executed. The SQL string may contain bind parameters. - * @param {Object|Array} Binds This function parameter is needed if there are bind parameters in the SQL statement. - * @param {IExecuteOptions} options This is an optional parameter to execute() that may be used to control statement execution. - * @param {(err: any, value: IExecuteReturn) => void} callback Callback function with the execution results. + * @param {string} sql SQL Statement. + * @param {IExecuteOptions} options Options object + * @param {(err: any, value: IExecuteReturn) => void} callback Callback function to receive the result. */ execute(sql: string, - binds: IExecutionBinds | Array, - options: IExecuteOptions, - callback: (err: any, value: IExecuteReturn) => void): void; + options: IExecuteOptions, + callback: (err: any, value: IExecuteReturn) => void): void; + + /** + * This call executes a SQL or PL/SQL statement. See SQL Execution for examples. + * The statement to be executed may contain IN binds, OUT or IN OUT bind values or variables, which are bound using either an object or an array. + * A callback function returns a result object, containing any fetched rows, the values of any OUT and IN OUT bind variables, and the number of rows affected by the execution of DML statements. + * @param {string} sql SQL Statement. + * @param {(err: any, value: IExecuteReturn) => void} callback Callback function to receive the result. + */ execute(sql: string, - binds: IExecutionBinds | Array, - callback: (err: any, value: IExecuteReturn) => void): void; + callback: (err: any, value: IExecuteReturn) => void): void; + + /** + * This call executes a SQL or PL/SQL statement. See SQL Execution for examples. + * The statement to be executed may contain IN binds, OUT or IN OUT bind values or variables, which are bound using either an object or an array. + * @param {string} sql SQL Statement. + * @param {Object|Array} bindParams Binds Object/Array + * @param {IExecuteOptions} options Options object + * @returns A Promise of a result object, containing any fetched rows, the values of any OUT and IN OUT bind variables, and the number of rows affected by the execution of DML statements. + */ execute(sql: string, - callback: (err: any, value: IExecuteReturn) => void): void; + bindParams?: Object | Array, + options?: IExecuteOptions): IPromise; /** - * Releases a connection. If the connection was obtained from the pool, the connection is returned to the pool. - * Note: calling release() when connections are no longer required is strongly encouraged. Releasing helps avoid resource leakage and can improve system efficiency. - * When a connection is released, any ongoing transaction on the connection is rolled back. - * After releasing a connection to a pool, there is no guarantee a subsequent getConnection() call gets back the same database connection. The application must redo any ALTER SESSION statements on the new connection object, as required. - * This is an asynchronous call. - * @param {(err: any) => void} callback Callback function to be called when the connection has been released. + * This function provides query streaming support. The parameters are the same as execute() except a callback is not used. Instead this function returns a stream used to fetch data. + * Each row is returned as a data event. Query metadata is available via a metadata event. The end event indicates the end of the query results. + * Query results must be fetched to completion to avoid resource leaks. + * The connection must remain open until the stream is completely read. + * For tuning purposes the oracledb.maxRows property can be used to size an internal buffer used by queryStream(). Note it does not limit the number of rows returned by the stream. The oracledb.prefetchRows value will also affect performance. + * @param {string} sql SQL Statement. + * @param {Object|Array} bindParams Binds Object/Array + * @param {IExecuteOptions} options Options object + * @returns Readable Stream for queries. + */ + queryStream(sql: string, + bindParams?: Object | Array, + options?: IExecuteOptions): stream.Readable; + + /** + * An alias for Connection.close(). + * @param {(err: any) => void} callback Callback on close done. */ release(callback: (err: any) => void): void; /** - * This call commits the current transaction in progress on the connection. - * This is an asynchronous call. - * @param {(err: any) => void} callback Callback on commit done. + * An alias for Connection.close(). + * @returns A void Promise on close done. */ - commit(callback: (err: any) => void): void; + release(): IPromise; /** - * SThis call rolls back the current transaction in progress on the connection. - * This is an asynchronous call. + * Send a rollback requisition to database. * @param {(err: any) => void} callback Callback on rollback done. */ rollback(callback: (err: any) => void): void; /** - * This call stops the currently running operation on the connection. - * If there is no operation in progress or the operation has completed by the time the break is issued, the break() is effectively a no-op. - * If the running asynchronous operation is interrupted, its callback will return an error. - * This is an asynchronous call. - * @param {(err: any) => void} callback Callback on break done. + * Send a rollback requisition to database. + * @returns A void Promise on rollback done. */ - break(callback: (err: any) => void): void; + rollback(): IPromise } export interface IConnectionPool { - /** The maximum number of connections that can be open in the connection pool. */ + /** + * The number of currently active connections in the connection pool i.e. the number of connections currently checked-out using getConnection(). + */ + connectionsInUse: number; + /** + * The number of currently open connections in the underlying connection pool. + */ + connectionsOpen: number; + /** + * The number of connections that are opened whenever a connection request exceeds the number of currently open connections. + */ + poolIncrement: number; + /** + * The maximum number of connections that can be open in the connection pool. + */ poolMax: number; - /** The minimum number of connections a connection pool maintains, even when there is no activity to the target database. */ + /** + * The minimum number of connections a connection pool maintains, even when there is no activity to the target database. + */ poolMin: number; - /** The number of connections that are opened whenever a connection request exceeds the number of currently open connections. */ - poolIncrement: number; - /** The time (in seconds) after which the pool terminates idle connections (unused in the pool). The number of connection does not drop below poolMin. */ + /** + * The time (in seconds) after which the pool terminates idle connections (unused in the pool). The number of connections does not drop below poolMin. + */ poolTimeout: number; - /** The number of currently open connections in the underlying connection pool. */ - connectionsOpen: number; - /** The number of currently active connections in the connection pool i.e. the number of connections currently checked-out using getConnection(). */ - connectionsInUse: number; + /** + * Determines whether requests for connections from the pool are queued when the number of connections "checked out" from the pool has reached the maximum number specified by poolMax. + */ + queueRequests: number; + /** + * The time (in milliseconds) that a connection request should wait in the queue before the request is terminated. + */ + queueTimeout: number; /** * The number of statements to be cached in the statement cache of each connection. - * The default is the stmtCacheSize property of the Oracledb object when the pool is created. */ stmtCacheSize: number; + /** - * This call terminates the connection pool. - * Any open connections should be released with release() before terminate() is called. - * This is an asynchronous call. + * Finalizes the connection pool. * @param {(err:any)=>void} callback Callback called when the pool is terminated or when some error occurs * @returns void */ - terminate(callback: (err: any) => void): void; + close(callback: (err: any) => void): void; + + /** + * Finalizes the connection pool. + * @returns Promise to when the close finishes. + */ + close(): IPromise; + /** * This method obtains a connection from the connection pool. * If a previously opened connection is available in the pool, that connection is returned. If all connections in the pool are in use, a new connection is created and returned to the caller, as long as the number of connections does not exceed the specified maximum for the pool. If the pool is at its maximum limit, the getConnection() call results in an error, such as ORA-24418: Cannot open further sessions. - * This is an asynchronous call. * @param {(err:any,connection:IConnection)=>void} callback Callback called when the connection is available or when some error occurs. * @returns void * @see {@link https://jsao.io/2015/03/making-a-wrapper-module-for-the-node-js-driver-for-oracle-database/} * @see {@link https://github.com/OraOpenSource/orawrap} */ getConnection(callback: (err: any, connection: IConnection) => void): void; + + /** + * This method obtains a connection from the connection pool. + * If a previously opened connection is available in the pool, that connection is returned. If all connections in the pool are in use, a new connection is created and returned to the caller, as long as the number of connections does not exceed the specified maximum for the pool. If the pool is at its maximum limit, the getConnection() call results in an error, such as ORA-24418: Cannot open further sessions. + * @returns An IConnection Promise to when the connection is available or when some error occurs. + * @see {@link https://jsao.io/2015/03/making-a-wrapper-module-for-the-node-js-driver-for-oracle-database/} + * @see {@link https://github.com/OraOpenSource/orawrap} + */ + getConnection(): IPromise; + + /** + * An alias for IConnectionPool.close(). + * @param {(err:any)=>void} callback Callback called when the pool is terminated or when some error occurs + * @returns void + */ + terminate(callback: (err: any) => void): void; + + /** + * An alias for IConnectionPool.close(). + * @returns Promise to when the close finishes. + */ + terminate(): IPromise; } - /** For execute(): Used with fetchInfo to reset the fetch type to the database type */ export const DEFAULT: number; - /** For execute(): Bind as JavaScript string type */ + /** Data type */ export const STRING: number; - /** For execute(): Bind as JavaScript number type. Can also be used for fetchAsString and fetchInfo */ + /** Data type */ export const NUMBER: number; - /** For execute(): Bind as JavaScript date type. Can also be used for fetchAsString and fetchInfo */ + /** Data type */ export const DATE: number; - /** For execute(): Bind a REF CURSOR to a node-oracledb ResultSet class */ + /** Data type */ export const CURSOR: number; - /** For execute(): Bind a RAW to a Node.js Buffer */ + /** Data type */ export const BUFFER: number; - /** For execute(): Bind a CLOB to a Node.js Stream */ + /** Data type */ export const CLOB: number; - /** For execute(): Bind a BLOB to a Node.js Stream */ + /** Data type */ export const BLOB: number; - /** For execute(): Direction for IN binds */ + /** Bind direction */ export const BIND_IN: number; - /** For execute(): Direction for IN OUT binds */ + /** Bind direction */ export const BIND_INOUT: number; - /** For execute(): Direction for OUT binds */ + /** Bind direction */ export const BIND_OUT: number; - /** For outFormat: Fetch each row as array of column values */ + /** outFormat */ export const ARRAY: number; - /** For outFormat: Fetch each row as an object */ + /** outFormat */ export const OBJECT: number; /** @@ -377,145 +501,90 @@ declare module 'oracledb' { */ export function newLob(iLob: ILob): Lob; + /** Default transaction behaviour of auto commit for each statement. */ + export var autoCommit: boolean; /** - * Obtains a connection directly from an Oracledb object. - * These connections are not pooled. For situations where connections are used infrequently, this call may be more efficient than creating and managing a connection pool. However, in most cases, Oracle recommends getting new connections from a connection pool. - * This is an asynchronous call. - * @param {IConnectionAttributes} connectionAttributes Parameters to stablish the connection. - * @param {(err:any,connection:IConnection)=>void} callback Callback to run when the connection gets stablished or when some error occurs. - * @returns void - */ - export function getConnection(connectionAttributes: IConnectionAttributes, callback: (err: any, connection: IConnection) => void): void; - - /** - * This method creates a pool of connections with the specified username, password and connection string. - * This is an asynchronous call. - * Internally, createPool() creates an OCI Session Pool for each Pool object. - * The default properties may be overridden by specifying new properties in the poolAttrs parameter. - * A pool should be terminated with the terminate() call. - * - * @param {IPoolAttributes} poolAttributes Parameters to stablish the connection pool. - * @param {(err:any,connection:IConnectionPool)=>void} callback Callback to run when the connection pool gets created or when some error occurs. - * @returns void + * The user-chosen Connection class value defines a logical name for connections. Most single purpose applications should set connectionClass when using a connection pool or DRCP. + * When a pooled session has a connection class, Oracle ensures that the session is not shared outside of that connection class. */ - export function createPool(poolAttributes: IPoolAttributes, callback: (err: any, connection: IConnectionPool) => void): void; - - + export var connectionClass: string; /** - * If this property is true, then the transaction in the current connection is automatically committed at the end of statement execution. - * The default value is false. - * This property may be overridden in an execute() call. - * Note prior to node-oracledb 0.5 this property was called isAutoCommit. - */ - export var autoCommit: boolean; - - /** - * If this property is true then connections are established using external authentication. See External Authentication for more information. - * The default value is false. - * The user and password properties for connecting or creating a pool should not be set when externalAuth is true. - * This property can be overridden in the Oracledb getConnection() or createPool() calls. - * Note prior to node-oracledb 0.5 this property was called isExternalAuth. + * Determines whether additional metadata is available for queries and for REF CURSORs returned from PL/SQL blocks. + * The default value for extendedMetaData is false. With this value, the result.metaData result.resultSet.metaData objects only include column names. */ + export var extendedMetaData: boolean; + /** Default authentication/authorization method. When true, the SO trusted user will be used. */ export var externalAuth: boolean; - /** - * The maximum number of connections to which a connection pool can grow. - * The default value is 4. - * This property may be overridden when creating the connection pool. + * An array of node-oracledb types. When any column having the specified type is queried with execute(), the column data is returned as a string instead of the native representation. For column types not specified in fetchAsString, native types will be returned. + * By default all columns are returned as native types. */ + export var fetchAsString: Array; + /** Default size in bytes that the driver will fetch from LOBs in advance. */ + export var lobPrefetchSize: number; + /** Default maximum number of rows to be fetched in statements not using ResultSets */ + export var maxRows: number; + /** Version of OCI that is used. */ + export var oracleClientVersion: number; + /** Default format for returning rows. When ARRAY, it will return Array>. When OBJECT, it will return Array. */ + export var outFormat: number; + /** Default number of connections to increment when available connections reach 0 in created pools. poolMax will be respected.*/ + export var poolIncrement: number; + /** Default maximum connections in created pools */ export var poolMax: number; - - /** - * The minimum number of connections a connection pool maintains, even when there is no activity to the target database. - * The default value is 0. - * This property may be overridden when creating a connection pool. - */ + /** Default minimum connections in created pools */ export var poolMin: number; - - /** - * The number of connections that are opened whenever a connection request exceeds the number of currently open connections. - * The default value is 1. - * This property may be overridden when creating a connection pool. - */ - export var poolIncrement: number; - - /** - * The number of seconds after which idle connections (unused in the pool) are terminated. Idle connections are terminated only when the pool is accessed. If the poolTimeout is set to 0, then idle connections are never terminated. - * The default value is 60. - * This property may be overridden when creating a connection pool. - */ + /** Default timeout for unused connections in pool to be released. poolMin will be respected.*/ export var poolTimeout: number; - - /** - * The number of statements that are cached in the statement cache of each connection. - * The default value is 30. - * This property may be overridden for specific Pool or Connection objects. - * In general, set the statement cache to the size of the working set of statements being executed by the application. Statement caching can be disabled by setting the size to 0. - */ - export var stmtCacheSize: number; - - /** - * The number of additional rows the underlying Oracle client library fetches whenever node-oracledb requests query data from the database. - * Prefetching is a tuning option to maximize data transfer efficiency and minimize round-trips to the database. The prefetch size does not affect when, or how many, rows are returned by node-oracledb to the application. The cache management is transparently handled by the Oracle client libraries. - * prefetchRows is ignored unless a ResultSet is used. - * The default value is 100. - * This property may be overridden in an execute() call. - */ + /** Default number of rows that the driver will fetch in each query.*/ export var prefetchRows: number; - /** - * The maximum number of rows that are fetched by the execute() call of the Connection object when not using a ResultSet. Rows beyond this limit are not fetched from the database. - * The default value is 100. - * This property may be overridden in an execute() call. - * To improve database efficiency, SQL queries should use a row limiting clause like OFFSET / FETCH or equivalent. The maxRows property can be used to stop badly coded queries from returning unexpectedly large numbers of rows. - * Adjust maxRows as required by each application or query. Values that are larger than required can result in sub-optimal memory usage. - * maxRows is ignored when fetching rows with a ResultSet. - * When the number of query rows is relatively big, or can't be predicted, it is recommended to use a ResultSet. This prevents query results being unexpectedly truncated by the maxRows limit and removes the need to oversize maxRows to avoid such truncation. + * Node-oracledb supports Promises on all methods. The standard Promise library is used in Node 0.12 and greater. Promise support is not enabled by default in Node 0.10. */ - export var maxRows: number; - + export var Promise: any; /** - * The format of rows fetched when using the execute() call. This can be either of the Oracledb constants ARRAY or OBJECT. The default value is ARRAY which is more efficient. - * If specified as ARRAY, each row is fetched as an array of column values. - * If specified as OBJECT, each row is fetched as a JavaScript object. The object has a property for each column name, with the property value set to the respective column value. The property name follows Oracle's standard name-casing rules. It will commonly be uppercase, since most applications create tables using unquoted, case-insensitive names. - * This property may be overridden in an execute() call. + * If this property is true and the number of connections "checked out" from the pool has reached the number specified by poolMax, then new requests for connections are queued until in-use connections are released. + * If this property is false and a request for a connection is made from a pool where the number of "checked out" connections has reached poolMax, then an ORA-24418 error indicating that further sessions cannot be opened will be returned. + * The default value is true. */ - export var outFormat: number; - + export var queueRequests: boolean; /** - * This readonly property gives a numeric representation of the node-oracledb version. For version x.y.z, this property gives the number: (10000 * x) + (100 * y) + z + * The number of milliseconds after which connection requests waiting in the connection request queue are terminated. If queueTimeout is 0, then queued connection requests are never terminated. + * The default value is 60000. */ + export var queueTimeout: number; + /** Default size of statements cache. Used to speed up creating queries.*/ + export var stmtCacheSize: number; + /** node-oracledb driver version. */ export var version: number; /** - * This attribute is temporarily disabled. Setting it has no effect. - * Node-oracledb internally uses Oracle LOB Locators to manipulate long object (LOB) data. LOB Prefetching allows LOB data to be returned early to node-oracledb when these locators are first returned. This is similar to the way row prefetching allows for efficient use of resources and round-trips between node-oracledb and the database. - * Prefetching of LOBs is mostly useful for small LOBs. - * The default size is 16384. + * Creates a database managed connection pool. + * @param {IPoolAttributes} poolAttributes Parameters to stablish the connection pool. + * @param {(err:any,connection:IConnectionPool)=>void} callback Callback to run when the connection pool gets created or when some error occurs. + * @returns void */ - export var lobPrefetchSize: number; + export function createPool(poolAttributes: IPoolAttributes, callback: (err: any, connection: IConnectionPool) => void): void; /** - * This readonly property gives a numeric representation of the Oracle client library version. For version a.b.c.d.e, this property gives the number: (100000000 * a) + (1000000 * b) + (10000 * c) + (100 * d) + e + * Creates a database managed connection pool. + * @param {IPoolAttributes} poolAttributes Parameters to stablish the connection pool. + * @returns Promise {(connection:IConnectionPool)=>any} Promise with the connection pool. */ - export var oracleClientVersion: number; + export function createPool(poolAttributes: IPoolAttributes): IPromise< IConnectionPool >; /** - * The user-chosen Connection class value defines a logical name for connections. Most single purpose applications should set connectionClass when using a connection pool or DRCP. - * When a pooled session has a connection class, Oracle ensures that the session is not shared outside of that connection class. - * The connection class value is similarly used by Database Resident Connection Pooling (DRCP) to allow or disallow sharing of sessions. - * For example, where two different kinds of users share one pool, you might set connectionClass to 'HRPOOL' for connections that access a Human Resources system, and it might be set to 'OEPOOL' for users of an Order Entry system. Users will only be given sessions of the appropriate class, allowing maximal reuse of resources in each case, and preventing any session information leaking between the two systems. + * Creates a connection with the database. + * @param {IConnectionAttributes} connectionAttributes Parameters to stablish the connection. + * @param {(err:any,connection:IConnection)=>void} callback Callback to run when the connection gets stablished or when some error occurs. + * @returns void */ - export var connectionClass: string; + export function getConnection(connectionAttributes: IConnectionAttributes, callback: (err: any, connection: IConnection) => void): void; /** - * An array of node-oracledb types. When any column having the specified type is queried with execute(), the column data is returned as a string instead of the native representation. For column types not specified in fetchAsString, native types will be returned. - * By default all columns are returned as native types. - * This property helps avoid situations where using JavaScript types can lead to numeric precision loss, or where date conversion is unwanted. - * The valid types that can be mapped to strings are DATE and NUMBER. - * The maximum length of a string created by this mapping is 200 bytes. - * Individual query columns in an execute() call can override the fetchAsString global setting by using fetchInfo. - * The conversion to string is handled by Oracle client libraries and is often referred to as defining the fetch type. + * Creates a connection with the database. + * @param {IConnectionAttributes} connectionAttributes Parameters to stablish the connection. + * @returns {(connection:IConnection)=>any} Promise with the connection. */ - export var fetchAsString: string; + export function getConnection(connectionAttributes: IConnectionAttributes): IPromise< IConnection >; } From 57e4b0771eb68119c070362cd5c51efd794b78b0 Mon Sep 17 00:00:00 2001 From: Richard Natal Date: Wed, 27 Jul 2016 14:45:37 -0300 Subject: [PATCH 5/5] Fixed misplaced reference. --- index.d.ts | 1180 ++++++++++++++++++++++++++-------------------------- 1 file changed, 590 insertions(+), 590 deletions(-) diff --git a/index.d.ts b/index.d.ts index dcfebb086..ee862bf96 100644 --- a/index.d.ts +++ b/index.d.ts @@ -1,590 +1,590 @@ -// Type definitions for oracledb v1.10.0 -// Project: https://github.com/oracle/node-oracledb -// Definitions by: Richard Natal -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/// - -declare module 'oracledb' { - import * as stream from "stream"; - - export type TRet = T | IPromise; - export type TFunc = (value: T) => TRet; - - export interface IPromise { - catch(onReject: TFunc) : IPromise; - then(onResolve?: TFunc, onReject?: TFunc) : IPromise; - } - - export interface ILob { - chunkSize: number; - length: number; - pieceSize: number; - offset?: number; - type: string; - /** - * Release method on ILob class. - * @remarks The cleanup() called by Release() only frees OCI error handle and Lob - * locator. These calls acquire mutex on OCI environment handle very briefly. - */ - release?(): void; - /** - * Read method on ILob class. - * @param {(err : any, chunk: string | Buffer) => void} callback Callback to recive the data from lob. - * @remarks CLobs send strings while BLobs send Buffer object. - */ - read?(callback: (err: any, chunk: string | Buffer) => void): void; - /** - * Read method on ILob class. - * @param {Buffer} data Data write into Lob. - * @param {(err: any) => void} callback Callback executed when writ is finished or when some error occured. - * @remarks CLobs send strings while BLobs send Buffer object. - */ - write?(data: Buffer, callback: (err: any) => void): void; - } - - export interface Lob extends stream.Duplex { - iLob: ILob; - /** This corresponds to the size used by the Oracle LOB layer when accessing or modifying the LOB value. */ - chunkSize: number; - /** Length of a queried LOB in bytes (for BLOBs) or characters (for CLOBs). */ - length: number; - /** - * he number of bytes (for BLOBs) or characters (for CLOBs) to read for each Stream 'data' event of a queried LOB. - * The default value is chunkSize. - * For efficiency, it is recommended that pieceSize be a multiple of chunkSize. - * The maximum value for pieceSize is limited to the value of UINT_MAX. - */ - pieceSize: number; - /** - * This read-only attribute shows the type of Lob being used. It will have the value of one of the constants Oracledb.BLOB or Oracledb.CLOB. The value is derived from the bind type when using LOB bind variables, or from the column type when a LOB is returned by a query. - */ - type: number; - - /** - * Do not call this... used internally by node-oracledb - */ - constructor(iLob: ILob, opts: stream.DuplexOptions): Lob; - constructor(iLob: ILob): Lob; - - /** - * Closes the current LOB. - * @param {(err: any) => void} callback? When passed, is called after the release. - * @returns void - */ - close(callback: (err: any) => void): void; - close(): void; - } - - export interface IConnectionAttributes { - user?: string; - password?: string; - connectString: string; - stmtCacheSize?: number; - externalAuth?: boolean; - } - - export interface IPoolAttributes extends IConnectionAttributes { - poolMax?: number; - poolMin?: number; - poolIncrement?: number; - poolTimeout?: number; - } - - export interface IExecuteOptions { - /** - * Transaction should auto commit after each statement? - * Overrides Oracledb autoCommit. - */ - autoCommit?: boolean; - /** - * Determines whether additional metadata is available for queries and for REF CURSORs returned from PL/SQL blocks. - * Overrides Oracledb extendedMetaData. - */ - extendedMetaData?: boolean; - /** - * Object defining how query column data should be represented in JavaScript. - * The fetchInfo property can be used to indicate that number or date columns in a query should be returned as strings instead of their native format. The property can be used in conjunction with, or instead of, the global setting fetchAsString. - * For example: - * - * fetchInfo: - * { - * "HIRE_DATE": { type : oracledb.STRING }, // return the date as a string - * "COMMISSION_PCT": { type : oracledb.DEFAULT } // override Oracledb.fetchAsString - * } - * - * Each column is specified by name, using Oracle's standard naming convention. - * The valid values for type are STRING and DEFAULT. The former indicates that the given column should be returned as a string. The latter can be used to override any global mapping given by fetchAsString and allow the column data for this query to be returned in native format. - * The maximum length of a string created by type mapping is 200 bytes. However, if a database column that is already of type STRING is specified in fetchInfo, then the actual database metadata will be used to determine the maximum length. - * Columns fetched from REF CURSORS are not mapped by fetchInfo settings in the execute() call. Use the global fetchAsString instead. - */ - fetchInfo?: Object; - /** - * Maximum number of rows that will be retrieved. Used when resultSet is false. - * Overrides Oracledb maxRows. - */ - maxRows?: number; - /** - * Result format - ARRAY o OBJECT - * Overrides Oracledb outFormat. - */ - outFormat?: number; - /** - * Number of rows to be fetched in advance. - * Overrides Oracledb prefetchRows. - */ - prefetchRows?: number; - /** - * Determines whether query results should be returned as a ResultSet object or directly. The default is false. - */ - resultSet?: boolean; - } - - export interface IExecuteReturn { - /** Metadata information - column names is always given. If the Oracledb extendedMetaData or execute() option extendedMetaData are true then additional information is included. */ - metaData?: Array; - /** This is either an array or an object containing OUT and IN OUT bind values. If bindParams is passed as an array, then outBinds is returned as an array. If bindParams is passed as an object, then outBinds is returned as an object. */ - outBinds?: Array | Object; - /** For SELECT statements when the resultSet option is true, use the resultSet object to fetch rows. See ResultSet Class. */ - resultSet?: IResultSet; - /** For SELECT statements where the resultSet option is false or unspecified, rows contains an array of fetched rows. It will be NULL if there is an error or the SQL statement was not a SELECT statement. By default, the rows are in an array of column value arrays, but this can be changed to arrays of objects by setting outFormat to OBJECT. If a single row is fetched, then rows is an array that contains one single row. The number of rows returned is limited to the maxRows configuration property of the Oracledb object, although this may be overridden in any execute() call. */ - rows?: Array> | Array; - /** For DML statements (including SELECT FOR UPDATE) this contains the number of rows affected, for example the number of rows inserted. For non-DML statements such as queries, or if no rows are affected, then rowsAffected will be zero. */ - rowsAffected?: number; - } - - export interface IMetaData { - /** The column name follows Oracle's standard name-casing rules. It will commonly be uppercase, since most applications create tables using unquoted, case-insensitive names. */ - name: string; - /** one of the Node-oracledb Type Constant values. */ - fetchType?: number; - /** one of the Node-oracledb Type Constant values. */ - dbType?: number; - /** the database byte size. This is only set for DB_TYPE_VARCHAR, DB_TYPE_CHAR and DB_TYPE_RAW column types. */ - byteSize?: number; - /** set only for DB_TYPE_NUMBER, DB_TYPE_TIMESTAMP, DB_TYPE_TIMESTAMP_TZ and DB_TYPE_TIMESTAMP_LTZ columns. */ - precision?: number; - /** set only for DB_TYPE_NUMBER columns. */ - scale: number; - /** indicates whether NULL values are permitted for this column. */ - nullable?: boolean; - } - - export interface IResultSet { - /** - * Contains an array of objects with metadata about the query or REF CURSOR columns. - * Each column's name is always given. If the Oracledb extendedMetaData or execute() option extendedMetaData are true then additional information is included. - */ - metaData?: Array; - - /** - * Closes a ResultSet. Applications should always call this at the end of fetch or when no more rows are needed. - * @param {(err:any)=>void} callback Callback called on finish or when some error occurs. - * @returns void - * @remarks Applications should always call this at the end of fetch or when no more rows are needed. - */ - close(callback: (err: any) => void): void; - - /** - * Closes a ResultSet. Applications should always call this at the end of fetch or when no more rows are needed. - * @returns A void Promise on finish or when some error occurs. - * @remarks Applications should always call this at the end of fetch or when no more rows are needed. - */ - close(): IPromise; - - /** - * This call fetches one row of the result set as an object or an array of column values, depending on the value of outFormat. - * At the end of fetching, the ResultSet should be freed by calling close(). - * @param {(err:any,row:Array|Object)=>void} callback Callback called when the row is available or when some error occurs. - * @returns void - */ - getRow(callback: (err: any, row: Array | Object) => void): void; - - /** - * This call fetches one row of the result set as an object or an array of column values, depending on the value of outFormat. - * At the end of fetching, the ResultSet should be freed by calling close(). - * @returns Promise when the row is available or when some error occurs. - */ - getRow(): IPromise | Object>; - - /** - * This synchronous method converts a ResultSet into a stream. - * It can be used to make ResultSets from top-level queries or from REF CURSOR bind variables streamable. To make top-level queries streamable, the alternative connection.queryStream() method may be easier to use. - * @returns synchronous stream of result set. - */ - toQueryStream(): stream.Readable; - } - - export interface IConnection { - /** - * The action attribute for end-to-end application tracing. - * This is a write-only property. Displaying a Connection object will show a value of null for this attribute. See End-to-end Tracing, Mid-tier Authentication, and Auditing. - */ - action: string; - /** - * The client identifier for end-to-end application tracing, use with mid-tier authentication, and with Virtual Private Databases. - * This is a write-only property. Displaying a Connection object will show a value of null for this attribute. See End-to-end Tracing, Mid-tier Authentication, and Auditing. - */ - clientId: string; - /** - * The module attribute for end-to-end application tracing. - * This is a write-only property. Displaying a Connection object will show a value of null for this attribute. See End-to-end Tracing, Mid-tier Authentication, and Auditing. - */ - module: string; - /** - * This readonly property gives a numeric representation of the Oracle database version. For version a.b.c.d.e, this property gives the number: (100000000 * a) + (1000000 * b) + (10000 * c) + (100 * d) + e - */ - oracleServerVersion: number; - /** - * The number of statements to be cached in the statement cache of the connection. The default value is the stmtCacheSize property in effect in the Pool object when the connection is created in the pool. - */ - stmtCacheSize: number; - - /** - * This call stops the currently running operation on the connection. - * If there is no operation in progress or the operation has completed by the time the break is issued, the break() is effectively a no-op. - * If the running asynchronous operation is interrupted, its callback will return an error. - * @param {(err: any) => void} callback Callback on break done. - */ - break(callback: (err: any) => void): void; - - /** - * This call stops the currently running operation on the connection. - * If there is no operation in progress or the operation has completed by the time the break is issued, the break() is effectively a no-op. - * If the running asynchronous operation is interrupted, its callback will return an error. - * @returns A void promise when break is done. - */ - break(): IPromise; - - /** - * Releases a connection. If the connection was obtained from the pool, the connection is returned to the pool and is available for reuse. - * Note: calling close() when connections are no longer required is strongly encouraged. Releasing helps avoid resource leakage and can improve system efficiency. - * When a connection is released, any ongoing transaction on the connection is rolled back. - * After releasing a connection to a pool, there is no guarantee a subsequent getConnection() call gets back the same database connection. The application must redo any ALTER SESSION statements on the new connection object, as required. - * @param {(err: any) => void} callback Callback on close done. - */ - close(callback: (err: any) => void): void; - - /** - * Releases a connection. If the connection was obtained from the pool, the connection is returned to the pool and is available for reuse. - * Note: calling close() when connections are no longer required is strongly encouraged. Releasing helps avoid resource leakage and can improve system efficiency. - * When a connection is released, any ongoing transaction on the connection is rolled back. - * After releasing a connection to a pool, there is no guarantee a subsequent getConnection() call gets back the same database connection. The application must redo any ALTER SESSION statements on the new connection object, as required. - * @returns A void Promise on close done. - */ - close(): IPromise; - - /** - * Send a commit requisition to the database. - * @param {(err: any) => void} callback Callback on commit done. - */ - commit(callback: (err: any) => void): void; - - /** - * Send a commit requisition to the database. - * @returns A void Promise on commit done. - */ - commit(): IPromise; - - /** - * This call executes a SQL or PL/SQL statement. See SQL Execution for examples. - * The statement to be executed may contain IN binds, OUT or IN OUT bind values or variables, which are bound using either an object or an array. - * A callback function returns a result object, containing any fetched rows, the values of any OUT and IN OUT bind variables, and the number of rows affected by the execution of DML statements. - * @param {string} sql SQL Statement. - * @param {Object|Array} bindParams Binds Object/Array - * @param {IExecuteOptions} options Options object - * @param {(err: any, value: IExecuteReturn) => void} callback Callback function to receive the result. - */ - execute(sql: string, - bindParams: Object | Array, - options: IExecuteOptions, - callback: (err: any, value: IExecuteReturn) => void): void; - - /** - * This call executes a SQL or PL/SQL statement. See SQL Execution for examples. - * The statement to be executed may contain IN binds, OUT or IN OUT bind values or variables, which are bound using either an object or an array. - * A callback function returns a result object, containing any fetched rows, the values of any OUT and IN OUT bind variables, and the number of rows affected by the execution of DML statements. - * @param {string} sql SQL Statement. - * @param {Object|Array} bindParams Binds Object/Array - * @param {(err: any, value: IExecuteReturn) => void} callback Callback function to receive the result. - */ - execute(sql: string, - bindParams: Object | Array, - callback: (err: any, value: IExecuteReturn) => void): void; - - /** - * This call executes a SQL or PL/SQL statement. See SQL Execution for examples. - * The statement to be executed may contain IN binds, OUT or IN OUT bind values or variables, which are bound using either an object or an array. - * A callback function returns a result object, containing any fetched rows, the values of any OUT and IN OUT bind variables, and the number of rows affected by the execution of DML statements. - * @param {string} sql SQL Statement. - * @param {IExecuteOptions} options Options object - * @param {(err: any, value: IExecuteReturn) => void} callback Callback function to receive the result. - */ - execute(sql: string, - options: IExecuteOptions, - callback: (err: any, value: IExecuteReturn) => void): void; - - /** - * This call executes a SQL or PL/SQL statement. See SQL Execution for examples. - * The statement to be executed may contain IN binds, OUT or IN OUT bind values or variables, which are bound using either an object or an array. - * A callback function returns a result object, containing any fetched rows, the values of any OUT and IN OUT bind variables, and the number of rows affected by the execution of DML statements. - * @param {string} sql SQL Statement. - * @param {(err: any, value: IExecuteReturn) => void} callback Callback function to receive the result. - */ - execute(sql: string, - callback: (err: any, value: IExecuteReturn) => void): void; - - /** - * This call executes a SQL or PL/SQL statement. See SQL Execution for examples. - * The statement to be executed may contain IN binds, OUT or IN OUT bind values or variables, which are bound using either an object or an array. - * @param {string} sql SQL Statement. - * @param {Object|Array} bindParams Binds Object/Array - * @param {IExecuteOptions} options Options object - * @returns A Promise of a result object, containing any fetched rows, the values of any OUT and IN OUT bind variables, and the number of rows affected by the execution of DML statements. - */ - execute(sql: string, - bindParams?: Object | Array, - options?: IExecuteOptions): IPromise; - - /** - * This function provides query streaming support. The parameters are the same as execute() except a callback is not used. Instead this function returns a stream used to fetch data. - * Each row is returned as a data event. Query metadata is available via a metadata event. The end event indicates the end of the query results. - * Query results must be fetched to completion to avoid resource leaks. - * The connection must remain open until the stream is completely read. - * For tuning purposes the oracledb.maxRows property can be used to size an internal buffer used by queryStream(). Note it does not limit the number of rows returned by the stream. The oracledb.prefetchRows value will also affect performance. - * @param {string} sql SQL Statement. - * @param {Object|Array} bindParams Binds Object/Array - * @param {IExecuteOptions} options Options object - * @returns Readable Stream for queries. - */ - queryStream(sql: string, - bindParams?: Object | Array, - options?: IExecuteOptions): stream.Readable; - - /** - * An alias for Connection.close(). - * @param {(err: any) => void} callback Callback on close done. - */ - release(callback: (err: any) => void): void; - - /** - * An alias for Connection.close(). - * @returns A void Promise on close done. - */ - release(): IPromise; - - /** - * Send a rollback requisition to database. - * @param {(err: any) => void} callback Callback on rollback done. - */ - rollback(callback: (err: any) => void): void; - - /** - * Send a rollback requisition to database. - * @returns A void Promise on rollback done. - */ - rollback(): IPromise - } - - export interface IConnectionPool { - /** - * The number of currently active connections in the connection pool i.e. the number of connections currently checked-out using getConnection(). - */ - connectionsInUse: number; - /** - * The number of currently open connections in the underlying connection pool. - */ - connectionsOpen: number; - /** - * The number of connections that are opened whenever a connection request exceeds the number of currently open connections. - */ - poolIncrement: number; - /** - * The maximum number of connections that can be open in the connection pool. - */ - poolMax: number; - /** - * The minimum number of connections a connection pool maintains, even when there is no activity to the target database. - */ - poolMin: number; - /** - * The time (in seconds) after which the pool terminates idle connections (unused in the pool). The number of connections does not drop below poolMin. - */ - poolTimeout: number; - /** - * Determines whether requests for connections from the pool are queued when the number of connections "checked out" from the pool has reached the maximum number specified by poolMax. - */ - queueRequests: number; - /** - * The time (in milliseconds) that a connection request should wait in the queue before the request is terminated. - */ - queueTimeout: number; - /** - * The number of statements to be cached in the statement cache of each connection. - */ - stmtCacheSize: number; - - /** - * Finalizes the connection pool. - * @param {(err:any)=>void} callback Callback called when the pool is terminated or when some error occurs - * @returns void - */ - close(callback: (err: any) => void): void; - - /** - * Finalizes the connection pool. - * @returns Promise to when the close finishes. - */ - close(): IPromise; - - /** - * This method obtains a connection from the connection pool. - * If a previously opened connection is available in the pool, that connection is returned. If all connections in the pool are in use, a new connection is created and returned to the caller, as long as the number of connections does not exceed the specified maximum for the pool. If the pool is at its maximum limit, the getConnection() call results in an error, such as ORA-24418: Cannot open further sessions. - * @param {(err:any,connection:IConnection)=>void} callback Callback called when the connection is available or when some error occurs. - * @returns void - * @see {@link https://jsao.io/2015/03/making-a-wrapper-module-for-the-node-js-driver-for-oracle-database/} - * @see {@link https://github.com/OraOpenSource/orawrap} - */ - getConnection(callback: (err: any, connection: IConnection) => void): void; - - /** - * This method obtains a connection from the connection pool. - * If a previously opened connection is available in the pool, that connection is returned. If all connections in the pool are in use, a new connection is created and returned to the caller, as long as the number of connections does not exceed the specified maximum for the pool. If the pool is at its maximum limit, the getConnection() call results in an error, such as ORA-24418: Cannot open further sessions. - * @returns An IConnection Promise to when the connection is available or when some error occurs. - * @see {@link https://jsao.io/2015/03/making-a-wrapper-module-for-the-node-js-driver-for-oracle-database/} - * @see {@link https://github.com/OraOpenSource/orawrap} - */ - getConnection(): IPromise; - - /** - * An alias for IConnectionPool.close(). - * @param {(err:any)=>void} callback Callback called when the pool is terminated or when some error occurs - * @returns void - */ - terminate(callback: (err: any) => void): void; - - /** - * An alias for IConnectionPool.close(). - * @returns Promise to when the close finishes. - */ - terminate(): IPromise; - } - - export const DEFAULT: number; - /** Data type */ - export const STRING: number; - /** Data type */ - export const NUMBER: number; - /** Data type */ - export const DATE: number; - /** Data type */ - export const CURSOR: number; - /** Data type */ - export const BUFFER: number; - /** Data type */ - export const CLOB: number; - /** Data type */ - export const BLOB: number; - /** Bind direction */ - export const BIND_IN: number; - /** Bind direction */ - export const BIND_INOUT: number; - /** Bind direction */ - export const BIND_OUT: number; - /** outFormat */ - export const ARRAY: number; - /** outFormat */ - export const OBJECT: number; - - /** - * Do not use this method - used internally by node-oracledb. - */ - export function newLob(iLob: ILob): Lob; - - /** Default transaction behaviour of auto commit for each statement. */ - export var autoCommit: boolean; - /** - * The user-chosen Connection class value defines a logical name for connections. Most single purpose applications should set connectionClass when using a connection pool or DRCP. - * When a pooled session has a connection class, Oracle ensures that the session is not shared outside of that connection class. - */ - export var connectionClass: string; - /** - * Determines whether additional metadata is available for queries and for REF CURSORs returned from PL/SQL blocks. - * The default value for extendedMetaData is false. With this value, the result.metaData result.resultSet.metaData objects only include column names. - */ - export var extendedMetaData: boolean; - /** Default authentication/authorization method. When true, the SO trusted user will be used. */ - export var externalAuth: boolean; - /** - * An array of node-oracledb types. When any column having the specified type is queried with execute(), the column data is returned as a string instead of the native representation. For column types not specified in fetchAsString, native types will be returned. - * By default all columns are returned as native types. - */ - export var fetchAsString: Array; - /** Default size in bytes that the driver will fetch from LOBs in advance. */ - export var lobPrefetchSize: number; - /** Default maximum number of rows to be fetched in statements not using ResultSets */ - export var maxRows: number; - /** Version of OCI that is used. */ - export var oracleClientVersion: number; - /** Default format for returning rows. When ARRAY, it will return Array>. When OBJECT, it will return Array. */ - export var outFormat: number; - /** Default number of connections to increment when available connections reach 0 in created pools. poolMax will be respected.*/ - export var poolIncrement: number; - /** Default maximum connections in created pools */ - export var poolMax: number; - /** Default minimum connections in created pools */ - export var poolMin: number; - /** Default timeout for unused connections in pool to be released. poolMin will be respected.*/ - export var poolTimeout: number; - /** Default number of rows that the driver will fetch in each query.*/ - export var prefetchRows: number; - /** - * Node-oracledb supports Promises on all methods. The standard Promise library is used in Node 0.12 and greater. Promise support is not enabled by default in Node 0.10. - */ - export var Promise: any; - /** - * If this property is true and the number of connections "checked out" from the pool has reached the number specified by poolMax, then new requests for connections are queued until in-use connections are released. - * If this property is false and a request for a connection is made from a pool where the number of "checked out" connections has reached poolMax, then an ORA-24418 error indicating that further sessions cannot be opened will be returned. - * The default value is true. - */ - export var queueRequests: boolean; - /** - * The number of milliseconds after which connection requests waiting in the connection request queue are terminated. If queueTimeout is 0, then queued connection requests are never terminated. - * The default value is 60000. - */ - export var queueTimeout: number; - /** Default size of statements cache. Used to speed up creating queries.*/ - export var stmtCacheSize: number; - /** node-oracledb driver version. */ - export var version: number; - - /** - * Creates a database managed connection pool. - * @param {IPoolAttributes} poolAttributes Parameters to stablish the connection pool. - * @param {(err:any,connection:IConnectionPool)=>void} callback Callback to run when the connection pool gets created or when some error occurs. - * @returns void - */ - export function createPool(poolAttributes: IPoolAttributes, callback: (err: any, connection: IConnectionPool) => void): void; - - /** - * Creates a database managed connection pool. - * @param {IPoolAttributes} poolAttributes Parameters to stablish the connection pool. - * @returns Promise {(connection:IConnectionPool)=>any} Promise with the connection pool. - */ - export function createPool(poolAttributes: IPoolAttributes): IPromise< IConnectionPool >; - - /** - * Creates a connection with the database. - * @param {IConnectionAttributes} connectionAttributes Parameters to stablish the connection. - * @param {(err:any,connection:IConnection)=>void} callback Callback to run when the connection gets stablished or when some error occurs. - * @returns void - */ - export function getConnection(connectionAttributes: IConnectionAttributes, callback: (err: any, connection: IConnection) => void): void; - - /** - * Creates a connection with the database. - * @param {IConnectionAttributes} connectionAttributes Parameters to stablish the connection. - * @returns {(connection:IConnection)=>any} Promise with the connection. - */ - export function getConnection(connectionAttributes: IConnectionAttributes): IPromise< IConnection >; -} +// Type definitions for oracledb v1.10.0 +// Project: https://github.com/oracle/node-oracledb +// Definitions by: Richard Natal +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +/// + +declare module 'oracledb' { + import * as stream from "stream"; + + export type TRet = T | IPromise; + export type TFunc = (value: T) => TRet; + + export interface IPromise { + catch(onReject: TFunc) : IPromise; + then(onResolve?: TFunc, onReject?: TFunc) : IPromise; + } + + export interface ILob { + chunkSize: number; + length: number; + pieceSize: number; + offset?: number; + type: string; + /** + * Release method on ILob class. + * @remarks The cleanup() called by Release() only frees OCI error handle and Lob + * locator. These calls acquire mutex on OCI environment handle very briefly. + */ + release?(): void; + /** + * Read method on ILob class. + * @param {(err : any, chunk: string | Buffer) => void} callback Callback to recive the data from lob. + * @remarks CLobs send strings while BLobs send Buffer object. + */ + read?(callback: (err: any, chunk: string | Buffer) => void): void; + /** + * Read method on ILob class. + * @param {Buffer} data Data write into Lob. + * @param {(err: any) => void} callback Callback executed when writ is finished or when some error occured. + * @remarks CLobs send strings while BLobs send Buffer object. + */ + write?(data: Buffer, callback: (err: any) => void): void; + } + + export interface Lob extends stream.Duplex { + iLob: ILob; + /** This corresponds to the size used by the Oracle LOB layer when accessing or modifying the LOB value. */ + chunkSize: number; + /** Length of a queried LOB in bytes (for BLOBs) or characters (for CLOBs). */ + length: number; + /** + * he number of bytes (for BLOBs) or characters (for CLOBs) to read for each Stream 'data' event of a queried LOB. + * The default value is chunkSize. + * For efficiency, it is recommended that pieceSize be a multiple of chunkSize. + * The maximum value for pieceSize is limited to the value of UINT_MAX. + */ + pieceSize: number; + /** + * This read-only attribute shows the type of Lob being used. It will have the value of one of the constants Oracledb.BLOB or Oracledb.CLOB. The value is derived from the bind type when using LOB bind variables, or from the column type when a LOB is returned by a query. + */ + type: number; + + /** + * Do not call this... used internally by node-oracledb + */ + constructor(iLob: ILob, opts: stream.DuplexOptions): Lob; + constructor(iLob: ILob): Lob; + + /** + * Closes the current LOB. + * @param {(err: any) => void} callback? When passed, is called after the release. + * @returns void + */ + close(callback: (err: any) => void): void; + close(): void; + } + + export interface IConnectionAttributes { + user?: string; + password?: string; + connectString: string; + stmtCacheSize?: number; + externalAuth?: boolean; + } + + export interface IPoolAttributes extends IConnectionAttributes { + poolMax?: number; + poolMin?: number; + poolIncrement?: number; + poolTimeout?: number; + } + + export interface IExecuteOptions { + /** + * Transaction should auto commit after each statement? + * Overrides Oracledb autoCommit. + */ + autoCommit?: boolean; + /** + * Determines whether additional metadata is available for queries and for REF CURSORs returned from PL/SQL blocks. + * Overrides Oracledb extendedMetaData. + */ + extendedMetaData?: boolean; + /** + * Object defining how query column data should be represented in JavaScript. + * The fetchInfo property can be used to indicate that number or date columns in a query should be returned as strings instead of their native format. The property can be used in conjunction with, or instead of, the global setting fetchAsString. + * For example: + * + * fetchInfo: + * { + * "HIRE_DATE": { type : oracledb.STRING }, // return the date as a string + * "COMMISSION_PCT": { type : oracledb.DEFAULT } // override Oracledb.fetchAsString + * } + * + * Each column is specified by name, using Oracle's standard naming convention. + * The valid values for type are STRING and DEFAULT. The former indicates that the given column should be returned as a string. The latter can be used to override any global mapping given by fetchAsString and allow the column data for this query to be returned in native format. + * The maximum length of a string created by type mapping is 200 bytes. However, if a database column that is already of type STRING is specified in fetchInfo, then the actual database metadata will be used to determine the maximum length. + * Columns fetched from REF CURSORS are not mapped by fetchInfo settings in the execute() call. Use the global fetchAsString instead. + */ + fetchInfo?: Object; + /** + * Maximum number of rows that will be retrieved. Used when resultSet is false. + * Overrides Oracledb maxRows. + */ + maxRows?: number; + /** + * Result format - ARRAY o OBJECT + * Overrides Oracledb outFormat. + */ + outFormat?: number; + /** + * Number of rows to be fetched in advance. + * Overrides Oracledb prefetchRows. + */ + prefetchRows?: number; + /** + * Determines whether query results should be returned as a ResultSet object or directly. The default is false. + */ + resultSet?: boolean; + } + + export interface IExecuteReturn { + /** Metadata information - column names is always given. If the Oracledb extendedMetaData or execute() option extendedMetaData are true then additional information is included. */ + metaData?: Array; + /** This is either an array or an object containing OUT and IN OUT bind values. If bindParams is passed as an array, then outBinds is returned as an array. If bindParams is passed as an object, then outBinds is returned as an object. */ + outBinds?: Array | Object; + /** For SELECT statements when the resultSet option is true, use the resultSet object to fetch rows. See ResultSet Class. */ + resultSet?: IResultSet; + /** For SELECT statements where the resultSet option is false or unspecified, rows contains an array of fetched rows. It will be NULL if there is an error or the SQL statement was not a SELECT statement. By default, the rows are in an array of column value arrays, but this can be changed to arrays of objects by setting outFormat to OBJECT. If a single row is fetched, then rows is an array that contains one single row. The number of rows returned is limited to the maxRows configuration property of the Oracledb object, although this may be overridden in any execute() call. */ + rows?: Array> | Array; + /** For DML statements (including SELECT FOR UPDATE) this contains the number of rows affected, for example the number of rows inserted. For non-DML statements such as queries, or if no rows are affected, then rowsAffected will be zero. */ + rowsAffected?: number; + } + + export interface IMetaData { + /** The column name follows Oracle's standard name-casing rules. It will commonly be uppercase, since most applications create tables using unquoted, case-insensitive names. */ + name: string; + /** one of the Node-oracledb Type Constant values. */ + fetchType?: number; + /** one of the Node-oracledb Type Constant values. */ + dbType?: number; + /** the database byte size. This is only set for DB_TYPE_VARCHAR, DB_TYPE_CHAR and DB_TYPE_RAW column types. */ + byteSize?: number; + /** set only for DB_TYPE_NUMBER, DB_TYPE_TIMESTAMP, DB_TYPE_TIMESTAMP_TZ and DB_TYPE_TIMESTAMP_LTZ columns. */ + precision?: number; + /** set only for DB_TYPE_NUMBER columns. */ + scale: number; + /** indicates whether NULL values are permitted for this column. */ + nullable?: boolean; + } + + export interface IResultSet { + /** + * Contains an array of objects with metadata about the query or REF CURSOR columns. + * Each column's name is always given. If the Oracledb extendedMetaData or execute() option extendedMetaData are true then additional information is included. + */ + metaData?: Array; + + /** + * Closes a ResultSet. Applications should always call this at the end of fetch or when no more rows are needed. + * @param {(err:any)=>void} callback Callback called on finish or when some error occurs. + * @returns void + * @remarks Applications should always call this at the end of fetch or when no more rows are needed. + */ + close(callback: (err: any) => void): void; + + /** + * Closes a ResultSet. Applications should always call this at the end of fetch or when no more rows are needed. + * @returns A void Promise on finish or when some error occurs. + * @remarks Applications should always call this at the end of fetch or when no more rows are needed. + */ + close(): IPromise; + + /** + * This call fetches one row of the result set as an object or an array of column values, depending on the value of outFormat. + * At the end of fetching, the ResultSet should be freed by calling close(). + * @param {(err:any,row:Array|Object)=>void} callback Callback called when the row is available or when some error occurs. + * @returns void + */ + getRow(callback: (err: any, row: Array | Object) => void): void; + + /** + * This call fetches one row of the result set as an object or an array of column values, depending on the value of outFormat. + * At the end of fetching, the ResultSet should be freed by calling close(). + * @returns Promise when the row is available or when some error occurs. + */ + getRow(): IPromise | Object>; + + /** + * This synchronous method converts a ResultSet into a stream. + * It can be used to make ResultSets from top-level queries or from REF CURSOR bind variables streamable. To make top-level queries streamable, the alternative connection.queryStream() method may be easier to use. + * @returns synchronous stream of result set. + */ + toQueryStream(): stream.Readable; + } + + export interface IConnection { + /** + * The action attribute for end-to-end application tracing. + * This is a write-only property. Displaying a Connection object will show a value of null for this attribute. See End-to-end Tracing, Mid-tier Authentication, and Auditing. + */ + action: string; + /** + * The client identifier for end-to-end application tracing, use with mid-tier authentication, and with Virtual Private Databases. + * This is a write-only property. Displaying a Connection object will show a value of null for this attribute. See End-to-end Tracing, Mid-tier Authentication, and Auditing. + */ + clientId: string; + /** + * The module attribute for end-to-end application tracing. + * This is a write-only property. Displaying a Connection object will show a value of null for this attribute. See End-to-end Tracing, Mid-tier Authentication, and Auditing. + */ + module: string; + /** + * This readonly property gives a numeric representation of the Oracle database version. For version a.b.c.d.e, this property gives the number: (100000000 * a) + (1000000 * b) + (10000 * c) + (100 * d) + e + */ + oracleServerVersion: number; + /** + * The number of statements to be cached in the statement cache of the connection. The default value is the stmtCacheSize property in effect in the Pool object when the connection is created in the pool. + */ + stmtCacheSize: number; + + /** + * This call stops the currently running operation on the connection. + * If there is no operation in progress or the operation has completed by the time the break is issued, the break() is effectively a no-op. + * If the running asynchronous operation is interrupted, its callback will return an error. + * @param {(err: any) => void} callback Callback on break done. + */ + break(callback: (err: any) => void): void; + + /** + * This call stops the currently running operation on the connection. + * If there is no operation in progress or the operation has completed by the time the break is issued, the break() is effectively a no-op. + * If the running asynchronous operation is interrupted, its callback will return an error. + * @returns A void promise when break is done. + */ + break(): IPromise; + + /** + * Releases a connection. If the connection was obtained from the pool, the connection is returned to the pool and is available for reuse. + * Note: calling close() when connections are no longer required is strongly encouraged. Releasing helps avoid resource leakage and can improve system efficiency. + * When a connection is released, any ongoing transaction on the connection is rolled back. + * After releasing a connection to a pool, there is no guarantee a subsequent getConnection() call gets back the same database connection. The application must redo any ALTER SESSION statements on the new connection object, as required. + * @param {(err: any) => void} callback Callback on close done. + */ + close(callback: (err: any) => void): void; + + /** + * Releases a connection. If the connection was obtained from the pool, the connection is returned to the pool and is available for reuse. + * Note: calling close() when connections are no longer required is strongly encouraged. Releasing helps avoid resource leakage and can improve system efficiency. + * When a connection is released, any ongoing transaction on the connection is rolled back. + * After releasing a connection to a pool, there is no guarantee a subsequent getConnection() call gets back the same database connection. The application must redo any ALTER SESSION statements on the new connection object, as required. + * @returns A void Promise on close done. + */ + close(): IPromise; + + /** + * Send a commit requisition to the database. + * @param {(err: any) => void} callback Callback on commit done. + */ + commit(callback: (err: any) => void): void; + + /** + * Send a commit requisition to the database. + * @returns A void Promise on commit done. + */ + commit(): IPromise; + + /** + * This call executes a SQL or PL/SQL statement. See SQL Execution for examples. + * The statement to be executed may contain IN binds, OUT or IN OUT bind values or variables, which are bound using either an object or an array. + * A callback function returns a result object, containing any fetched rows, the values of any OUT and IN OUT bind variables, and the number of rows affected by the execution of DML statements. + * @param {string} sql SQL Statement. + * @param {Object|Array} bindParams Binds Object/Array + * @param {IExecuteOptions} options Options object + * @param {(err: any, value: IExecuteReturn) => void} callback Callback function to receive the result. + */ + execute(sql: string, + bindParams: Object | Array, + options: IExecuteOptions, + callback: (err: any, value: IExecuteReturn) => void): void; + + /** + * This call executes a SQL or PL/SQL statement. See SQL Execution for examples. + * The statement to be executed may contain IN binds, OUT or IN OUT bind values or variables, which are bound using either an object or an array. + * A callback function returns a result object, containing any fetched rows, the values of any OUT and IN OUT bind variables, and the number of rows affected by the execution of DML statements. + * @param {string} sql SQL Statement. + * @param {Object|Array} bindParams Binds Object/Array + * @param {(err: any, value: IExecuteReturn) => void} callback Callback function to receive the result. + */ + execute(sql: string, + bindParams: Object | Array, + callback: (err: any, value: IExecuteReturn) => void): void; + + /** + * This call executes a SQL or PL/SQL statement. See SQL Execution for examples. + * The statement to be executed may contain IN binds, OUT or IN OUT bind values or variables, which are bound using either an object or an array. + * A callback function returns a result object, containing any fetched rows, the values of any OUT and IN OUT bind variables, and the number of rows affected by the execution of DML statements. + * @param {string} sql SQL Statement. + * @param {IExecuteOptions} options Options object + * @param {(err: any, value: IExecuteReturn) => void} callback Callback function to receive the result. + */ + execute(sql: string, + options: IExecuteOptions, + callback: (err: any, value: IExecuteReturn) => void): void; + + /** + * This call executes a SQL or PL/SQL statement. See SQL Execution for examples. + * The statement to be executed may contain IN binds, OUT or IN OUT bind values or variables, which are bound using either an object or an array. + * A callback function returns a result object, containing any fetched rows, the values of any OUT and IN OUT bind variables, and the number of rows affected by the execution of DML statements. + * @param {string} sql SQL Statement. + * @param {(err: any, value: IExecuteReturn) => void} callback Callback function to receive the result. + */ + execute(sql: string, + callback: (err: any, value: IExecuteReturn) => void): void; + + /** + * This call executes a SQL or PL/SQL statement. See SQL Execution for examples. + * The statement to be executed may contain IN binds, OUT or IN OUT bind values or variables, which are bound using either an object or an array. + * @param {string} sql SQL Statement. + * @param {Object|Array} bindParams Binds Object/Array + * @param {IExecuteOptions} options Options object + * @returns A Promise of a result object, containing any fetched rows, the values of any OUT and IN OUT bind variables, and the number of rows affected by the execution of DML statements. + */ + execute(sql: string, + bindParams?: Object | Array, + options?: IExecuteOptions): IPromise; + + /** + * This function provides query streaming support. The parameters are the same as execute() except a callback is not used. Instead this function returns a stream used to fetch data. + * Each row is returned as a data event. Query metadata is available via a metadata event. The end event indicates the end of the query results. + * Query results must be fetched to completion to avoid resource leaks. + * The connection must remain open until the stream is completely read. + * For tuning purposes the oracledb.maxRows property can be used to size an internal buffer used by queryStream(). Note it does not limit the number of rows returned by the stream. The oracledb.prefetchRows value will also affect performance. + * @param {string} sql SQL Statement. + * @param {Object|Array} bindParams Binds Object/Array + * @param {IExecuteOptions} options Options object + * @returns Readable Stream for queries. + */ + queryStream(sql: string, + bindParams?: Object | Array, + options?: IExecuteOptions): stream.Readable; + + /** + * An alias for Connection.close(). + * @param {(err: any) => void} callback Callback on close done. + */ + release(callback: (err: any) => void): void; + + /** + * An alias for Connection.close(). + * @returns A void Promise on close done. + */ + release(): IPromise; + + /** + * Send a rollback requisition to database. + * @param {(err: any) => void} callback Callback on rollback done. + */ + rollback(callback: (err: any) => void): void; + + /** + * Send a rollback requisition to database. + * @returns A void Promise on rollback done. + */ + rollback(): IPromise + } + + export interface IConnectionPool { + /** + * The number of currently active connections in the connection pool i.e. the number of connections currently checked-out using getConnection(). + */ + connectionsInUse: number; + /** + * The number of currently open connections in the underlying connection pool. + */ + connectionsOpen: number; + /** + * The number of connections that are opened whenever a connection request exceeds the number of currently open connections. + */ + poolIncrement: number; + /** + * The maximum number of connections that can be open in the connection pool. + */ + poolMax: number; + /** + * The minimum number of connections a connection pool maintains, even when there is no activity to the target database. + */ + poolMin: number; + /** + * The time (in seconds) after which the pool terminates idle connections (unused in the pool). The number of connections does not drop below poolMin. + */ + poolTimeout: number; + /** + * Determines whether requests for connections from the pool are queued when the number of connections "checked out" from the pool has reached the maximum number specified by poolMax. + */ + queueRequests: number; + /** + * The time (in milliseconds) that a connection request should wait in the queue before the request is terminated. + */ + queueTimeout: number; + /** + * The number of statements to be cached in the statement cache of each connection. + */ + stmtCacheSize: number; + + /** + * Finalizes the connection pool. + * @param {(err:any)=>void} callback Callback called when the pool is terminated or when some error occurs + * @returns void + */ + close(callback: (err: any) => void): void; + + /** + * Finalizes the connection pool. + * @returns Promise to when the close finishes. + */ + close(): IPromise; + + /** + * This method obtains a connection from the connection pool. + * If a previously opened connection is available in the pool, that connection is returned. If all connections in the pool are in use, a new connection is created and returned to the caller, as long as the number of connections does not exceed the specified maximum for the pool. If the pool is at its maximum limit, the getConnection() call results in an error, such as ORA-24418: Cannot open further sessions. + * @param {(err:any,connection:IConnection)=>void} callback Callback called when the connection is available or when some error occurs. + * @returns void + * @see {@link https://jsao.io/2015/03/making-a-wrapper-module-for-the-node-js-driver-for-oracle-database/} + * @see {@link https://github.com/OraOpenSource/orawrap} + */ + getConnection(callback: (err: any, connection: IConnection) => void): void; + + /** + * This method obtains a connection from the connection pool. + * If a previously opened connection is available in the pool, that connection is returned. If all connections in the pool are in use, a new connection is created and returned to the caller, as long as the number of connections does not exceed the specified maximum for the pool. If the pool is at its maximum limit, the getConnection() call results in an error, such as ORA-24418: Cannot open further sessions. + * @returns An IConnection Promise to when the connection is available or when some error occurs. + * @see {@link https://jsao.io/2015/03/making-a-wrapper-module-for-the-node-js-driver-for-oracle-database/} + * @see {@link https://github.com/OraOpenSource/orawrap} + */ + getConnection(): IPromise; + + /** + * An alias for IConnectionPool.close(). + * @param {(err:any)=>void} callback Callback called when the pool is terminated or when some error occurs + * @returns void + */ + terminate(callback: (err: any) => void): void; + + /** + * An alias for IConnectionPool.close(). + * @returns Promise to when the close finishes. + */ + terminate(): IPromise; + } + + export const DEFAULT: number; + /** Data type */ + export const STRING: number; + /** Data type */ + export const NUMBER: number; + /** Data type */ + export const DATE: number; + /** Data type */ + export const CURSOR: number; + /** Data type */ + export const BUFFER: number; + /** Data type */ + export const CLOB: number; + /** Data type */ + export const BLOB: number; + /** Bind direction */ + export const BIND_IN: number; + /** Bind direction */ + export const BIND_INOUT: number; + /** Bind direction */ + export const BIND_OUT: number; + /** outFormat */ + export const ARRAY: number; + /** outFormat */ + export const OBJECT: number; + + /** + * Do not use this method - used internally by node-oracledb. + */ + export function newLob(iLob: ILob): Lob; + + /** Default transaction behaviour of auto commit for each statement. */ + export var autoCommit: boolean; + /** + * The user-chosen Connection class value defines a logical name for connections. Most single purpose applications should set connectionClass when using a connection pool or DRCP. + * When a pooled session has a connection class, Oracle ensures that the session is not shared outside of that connection class. + */ + export var connectionClass: string; + /** + * Determines whether additional metadata is available for queries and for REF CURSORs returned from PL/SQL blocks. + * The default value for extendedMetaData is false. With this value, the result.metaData result.resultSet.metaData objects only include column names. + */ + export var extendedMetaData: boolean; + /** Default authentication/authorization method. When true, the SO trusted user will be used. */ + export var externalAuth: boolean; + /** + * An array of node-oracledb types. When any column having the specified type is queried with execute(), the column data is returned as a string instead of the native representation. For column types not specified in fetchAsString, native types will be returned. + * By default all columns are returned as native types. + */ + export var fetchAsString: Array; + /** Default size in bytes that the driver will fetch from LOBs in advance. */ + export var lobPrefetchSize: number; + /** Default maximum number of rows to be fetched in statements not using ResultSets */ + export var maxRows: number; + /** Version of OCI that is used. */ + export var oracleClientVersion: number; + /** Default format for returning rows. When ARRAY, it will return Array>. When OBJECT, it will return Array. */ + export var outFormat: number; + /** Default number of connections to increment when available connections reach 0 in created pools. poolMax will be respected.*/ + export var poolIncrement: number; + /** Default maximum connections in created pools */ + export var poolMax: number; + /** Default minimum connections in created pools */ + export var poolMin: number; + /** Default timeout for unused connections in pool to be released. poolMin will be respected.*/ + export var poolTimeout: number; + /** Default number of rows that the driver will fetch in each query.*/ + export var prefetchRows: number; + /** + * Node-oracledb supports Promises on all methods. The standard Promise library is used in Node 0.12 and greater. Promise support is not enabled by default in Node 0.10. + */ + export var Promise: any; + /** + * If this property is true and the number of connections "checked out" from the pool has reached the number specified by poolMax, then new requests for connections are queued until in-use connections are released. + * If this property is false and a request for a connection is made from a pool where the number of "checked out" connections has reached poolMax, then an ORA-24418 error indicating that further sessions cannot be opened will be returned. + * The default value is true. + */ + export var queueRequests: boolean; + /** + * The number of milliseconds after which connection requests waiting in the connection request queue are terminated. If queueTimeout is 0, then queued connection requests are never terminated. + * The default value is 60000. + */ + export var queueTimeout: number; + /** Default size of statements cache. Used to speed up creating queries.*/ + export var stmtCacheSize: number; + /** node-oracledb driver version. */ + export var version: number; + + /** + * Creates a database managed connection pool. + * @param {IPoolAttributes} poolAttributes Parameters to stablish the connection pool. + * @param {(err:any,connection:IConnectionPool)=>void} callback Callback to run when the connection pool gets created or when some error occurs. + * @returns void + */ + export function createPool(poolAttributes: IPoolAttributes, callback: (err: any, connection: IConnectionPool) => void): void; + + /** + * Creates a database managed connection pool. + * @param {IPoolAttributes} poolAttributes Parameters to stablish the connection pool. + * @returns Promise {(connection:IConnectionPool)=>any} Promise with the connection pool. + */ + export function createPool(poolAttributes: IPoolAttributes): IPromise< IConnectionPool >; + + /** + * Creates a connection with the database. + * @param {IConnectionAttributes} connectionAttributes Parameters to stablish the connection. + * @param {(err:any,connection:IConnection)=>void} callback Callback to run when the connection gets stablished or when some error occurs. + * @returns void + */ + export function getConnection(connectionAttributes: IConnectionAttributes, callback: (err: any, connection: IConnection) => void): void; + + /** + * Creates a connection with the database. + * @param {IConnectionAttributes} connectionAttributes Parameters to stablish the connection. + * @returns {(connection:IConnection)=>any} Promise with the connection. + */ + export function getConnection(connectionAttributes: IConnectionAttributes): IPromise< IConnection >; +}