Skip to content

Commit

Permalink
Cleaned up comments and README
Browse files Browse the repository at this point in the history
Changed version from 0.0.1 to 0.1.0 ;).
  • Loading branch information
Hypermediaisobar-admin committed Sep 9, 2014
1 parent a2c981e commit 13f1a76
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 16 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,9 @@ Run tests the node way, for example:

See test configuration file ([test/support/config.js][5]) for more information.

To test against checklist provided by any-db-adapter-spec, call it from
any-db-mssql adapter's directory set as current directory, for example it can be
called right after npm test mentioned above:
To test against any-db-adapter-spec, call it its tests from any-db-mssql
adapter's directory set as current directory, for example it can be called
right after npm test mentioned above:

node ../node-any-db-adapter-spec/bin/test-any-db-adapter --url 'mssql://'$DB_USER':'$DB_PASS'@'$DB_HOST'/'$DB_NAME'?instanceName='$DB_INST

Expand Down
24 changes: 12 additions & 12 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ var EventEmitter = require('events').EventEmitter;
var sql = require('tedious');

/**
* Implementation of Adapter as defined by any db API ({@link https://github.com/grncdr/node-any-db}).
* Implementation of Adapter as defined by Any-DB API ({@link https://github.com/grncdr/node-any-db}).
*
* @module any-db-mssql
*/
Expand Down Expand Up @@ -345,7 +345,7 @@ var setRequestParameters = function(request, parameters) {
*/

/**
* Adapter is defined by any db API.
* Adapter is defined by Any-DB API.
*
* @external any-db~Adapter
* @see {@link https://github.com/grncdr/node-any-db-adapter-spec#adapter}
Expand All @@ -355,7 +355,7 @@ var setRequestParameters = function(request, parameters) {
*/

/**
* Queryable is defined by any db API.
* Queryable is defined by Any-DB API.
*
* @external any-db~Queryable
* @see {@link https://github.com/grncdr/node-any-db-adapter-spec#queryable}
Expand All @@ -365,7 +365,7 @@ var setRequestParameters = function(request, parameters) {
*/

/**
* Query is defined by any db API.
* Query is defined by Any-DB API.
*
* @external any-db~Query
* @see {@link https://github.com/grncdr/node-any-db-adapter-spec#query}
Expand All @@ -376,7 +376,7 @@ var setRequestParameters = function(request, parameters) {
*/

/**
* Connection is defined by any db API.
* Connection is defined by Any-DB API.
*
* @external any-db~Connection
* @see {@link https://github.com/grncdr/node-any-db-adapter-spec#connection}
Expand Down Expand Up @@ -578,7 +578,7 @@ var makeQueryable = function(target) {
exports.name = 'mssql';

/**
* Extend any db API with namedParameterPrefix flag, that can be used when build SQL query strings
* Extend Any-DB API with namedParameterPrefix flag, that can be used when build SQL query strings
* with named parameters, for example:
*
* ```
Expand All @@ -592,7 +592,7 @@ exports.namedParameterPrefix = '@';
Object.defineProperty(exports, 'namedParameterPrefix', { value: '@', writable : false });

/**
* Extend any db API with positionalParameterPrefix flag, that can be used when build SQL query strings
* Extend Any-DB API with positionalParameterPrefix flag, that can be used when build SQL query strings
* with positioned parameters, for example:
*
* ```
Expand All @@ -605,7 +605,7 @@ exports.positionalParameterPrefix = '?';
Object.defineProperty(exports, 'positionalParameterPrefix', { value: '?', writable : false });

/**
* Implementation of `Adapter.createConnection` method defined by any db API.
* Implementation of `Adapter.createConnection` method defined by Any-DB API.
*
* @see {@link https://github.com/grncdr/node-any-db-adapter-spec#adaptercreateconnection}
* @param {any-db~Config} config
Expand All @@ -618,7 +618,7 @@ exports.createConnection = function(config, callback) {

makeQueryable(result);

// Tedious Connection has `close()` method, but any db
// Tedious Connection has `close()` method, but Any-DB
// expects `end()` method, so we have to build a bridge.
result.end = function(callback){
if (callback instanceof Function) {
Expand Down Expand Up @@ -685,7 +685,7 @@ exports.createConnection = function(config, callback) {
};

/**
* Partial implementation of `Adapter.createQuery` method defined by any db API.
* Partial implementation of `Adapter.createQuery` method defined by Any-DB API.
*
* Partial because returned Query DOES NOT inherit Readable stream.
* It inherits EventEmitter only, because Tedious library does not provide Readable
Expand All @@ -702,7 +702,7 @@ exports.createQuery = function(query, parameters, callback) {
return query;
}

// Tedious does not use Readable stream, so we cannot support any db fully :(.
// Tedious does not use Readable stream, so we cannot support Any-DB fully :(.
var result = new EventEmitter();

result.text = query;
Expand All @@ -726,7 +726,7 @@ exports.createQuery = function(query, parameters, callback) {
};

/**
* Extend any db API by providing function that returns Tedious type for given generic type name.
* Extend Any-DB API by providing function that returns Tedious type for given generic type name.
*
* Following type names are supported (aside from "native" type names supported by Tedious):
*
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "any-db-mssql",
"version": "0.0.1",
"version": "0.1.0",
"description": "The MSSQL adapter for any-db",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit 13f1a76

Please sign in to comment.