Skip to content

Commit a5025e1

Browse files
committed
Rename package
1 parent 914ff7d commit a5025e1

File tree

4 files changed

+8
-42
lines changed

4 files changed

+8
-42
lines changed

API.md

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@
66
* [.ConnectionPoolParty](#module_connection-pool-party.ConnectionPoolParty) ⇐ <code>EventEmitter</code>
77
* [new ConnectionPoolParty(config, [cb])](#new_module_connection-pool-party.ConnectionPoolParty_new)
88
* [.warmup([cb])](#module_connection-pool-party.ConnectionPoolParty+warmup) ⇒ <code>Promise</code>
9-
* [.request()](#module_connection-pool-party.ConnectionPoolParty+request) ⇒ <code>mssql.Request</code>
10-
* [.close([cb])](#module_connection-pool-party.ConnectionPoolParty+close) ⇒ <code>Promise</code>
11-
* [.stats()](#module_connection-pool-party.ConnectionPoolParty+stats) ⇒ <code>Object</code>
129
* [.forceFqdnConnectionPoolFactory(suffix)](#module_connection-pool-party.forceFqdnConnectionPoolFactory) ⇒ <code>Promise</code>
1310

1411
<a name="module_connection-pool-party.ConnectionPoolParty"></a>
@@ -20,9 +17,6 @@
2017
* [.ConnectionPoolParty](#module_connection-pool-party.ConnectionPoolParty) ⇐ <code>EventEmitter</code>
2118
* [new ConnectionPoolParty(config, [cb])](#new_module_connection-pool-party.ConnectionPoolParty_new)
2219
* [.warmup([cb])](#module_connection-pool-party.ConnectionPoolParty+warmup) ⇒ <code>Promise</code>
23-
* [.request()](#module_connection-pool-party.ConnectionPoolParty+request) ⇒ <code>mssql.Request</code>
24-
* [.close([cb])](#module_connection-pool-party.ConnectionPoolParty+close) ⇒ <code>Promise</code>
25-
* [.stats()](#module_connection-pool-party.ConnectionPoolParty+stats) ⇒ <code>Object</code>
2620

2721
<a name="new_module_connection-pool-party.ConnectionPoolParty_new"></a>
2822

@@ -65,36 +59,6 @@ being removed, which will allow warmup to be re-attempted.
6559
| --- | --- | --- |
6660
| [cb] | <code>function</code> | An optional callback interface. It is preferable to use the Promise-based interface. |
6761

68-
<a name="module_connection-pool-party.ConnectionPoolParty+request"></a>
69-
70-
#### connectionPoolParty.request() ⇒ <code>mssql.Request</code>
71-
Retrieve a new Request instance. This is the same Request provided by the mssql
72-
package, but it's specially extended to interact with ConnectionPoolParty.
73-
74-
**Kind**: instance method of [<code>ConnectionPoolParty</code>](#module_connection-pool-party.ConnectionPoolParty)
75-
**Returns**: <code>mssql.Request</code> - An extended instance of mssql.Request.
76-
<a name="module_connection-pool-party.ConnectionPoolParty+close"></a>
77-
78-
#### connectionPoolParty.close([cb]) ⇒ <code>Promise</code>
79-
Close all pools associated with this instance of ConnectionPoolParty
80-
81-
**Kind**: instance method of [<code>ConnectionPoolParty</code>](#module_connection-pool-party.ConnectionPoolParty)
82-
**Returns**: <code>Promise</code> - A Promise that resolves when all pools are closed. Will also
83-
resolve if there is an error encountered while closing the pools.
84-
85-
| Param | Type | Description |
86-
| --- | --- | --- |
87-
| [cb] | <code>function</code> | An optional callback interface. It is preferable to use the Promise-based interface. |
88-
89-
<a name="module_connection-pool-party.ConnectionPoolParty+stats"></a>
90-
91-
#### connectionPoolParty.stats() ⇒ <code>Object</code>
92-
Retrieve health and statistics for this ConnectionPoolParty and its associated
93-
pools.
94-
95-
**Kind**: instance method of [<code>ConnectionPoolParty</code>](#module_connection-pool-party.ConnectionPoolParty)
96-
**Returns**: <code>Object</code> - An object containing a bunch of health/stats data for this instance
97-
of ConnectionPoolParty and its associated pools.
9862
<a name="module_connection-pool-party.forceFqdnConnectionPoolFactory"></a>
9963

10064
### connection-pool-party.forceFqdnConnectionPoolFactory(suffix) ⇒ <code>Promise</code>

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
- `mssql` dependency has been upgraded from 6.x to 9.x. See the [changelog](https://github.com/tediousjs/node-mssql/blob/master/CHANGELOG.txt) for that package for a list of changes that may be required to your configuration options.
66
- Node >=14 is now required
77

8+
Additionally, the package is now published as `@godaddy/mssql-pool-party`
9+
810
# 0.5.2 (January 10, 2020)
911

1012
## Features

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# mssql-pool-party
1+
# @godaddy/mssql-pool-party
22

33
ES6+ extension of [mssql](https://github.com/patriksimek/node-mssql) that provides:
44

@@ -23,7 +23,7 @@ Jump on in, the water's fine.
2323

2424
```js
2525
// my-db.js
26-
import sql from 'mssql-pool-party';
26+
import sql from '@godaddy/mssql-pool-party';
2727

2828
const config = {
2929
// See configuration section below for more information
@@ -49,7 +49,7 @@ export default connection;
4949

5050
```js
5151
// call-proc.js
52-
import sql from 'mssql-pool-party';
52+
import sql from '@godaddy/mssql-pool-party';
5353
import myDb from './my-db';
5454

5555
export default function callProc() {
@@ -65,7 +65,7 @@ export default function callProc() {
6565

6666
```js
6767
// my-db.js
68-
import sql from 'mssql-pool-party';
68+
import sql from '@godaddy/mssql-pool-party';
6969
import jsonFileDsnProvider from 'my-example-dsn-provider';
7070

7171
// grab DSN(s) from a json file
@@ -102,7 +102,7 @@ export default connection;
102102

103103
```js
104104
// run-query.js
105-
import sql from 'mssql-pool-party';
105+
import sql from '@godaddy/mssql-pool-party';
106106
import myDb from './my-db';
107107

108108
export default function runQuery(id) {

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "mssql-pool-party",
2+
"name": "@godaddy/mssql-pool-party",
33
"version": "1.0.0",
44
"description": "Extension of mssql that provides management of multiple connection pools, dsns, retries, and more",
55
"main": "dist/index.js",

0 commit comments

Comments
 (0)