Skip to content

Commit

Permalink
Fixing wrong return type in subcscribe docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gbahamondezc committed Apr 11, 2018
1 parent f9c6376 commit 87154f5
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ Configure and subscribe to Postgres Notify automatically for a given set of tabl


* [pg-notify](#module_pg-notify)
* [~Subscribe to all database events of a given list of tables(tables)](#module_pg-notify..Subscribe to all database events of a given list of tables) ⇒ <code>EventEmitter</code>
* [~Subscribe to all database events of a given list of tables(tables)](#module_pg-notify..Subscribe to all database events of a given list of tables) ⇒ <code>Promise</code>
* [~Create the functions and triggers to configure pg-notify.(tables)](#module_pg-notify..Create the functions and triggers to configure pg-notify.) ⇒ <code>Promise</code>

<a name="module_pg-notify..Subscribe to all database events of a given list of tables"></a>

### pg-notify~Subscribe to all database events of a given list of tables(tables) ⇒ <code>EventEmitter</code>
### pg-notify~Subscribe to all database events of a given list of tables(tables) ⇒ <code>Promise</code>
**Kind**: inner method of [<code>pg-notify</code>](#module_pg-notify)
**Returns**: <code>EventEmitter</code> - A nodejs EventEmitter which emits when any of the listed tables changes.
**Returns**: <code>Promise</code> - a promise wich resolves an NodeJS EventEmitter

| Param | Type | Description |
| --- | --- | --- |
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": "@becual/pg-notify",
"version": "2.0.3",
"version": "2.0.4",
"description": "NodeJS PostgreSQL pg-notify subscription library",
"main": "./src/index.js",
"repository": "[email protected]:becual/node-pg-notify.git",
Expand Down
2 changes: 1 addition & 1 deletion src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ module.exports = (client, configObject = defaultConfig) => {
/**
* @method Subscribe to all database events of a given list of tables
* @param {string[]} tables - An array of table names to listen
* @returns {EventEmitter} A nodejs EventEmitter which emits when any of the listed tables changes.
* @returns { Promise } a promise wich resolves an NodeJS EventEmitter
*
* @example
* const { Client } = require('pg');
Expand Down

0 comments on commit 87154f5

Please sign in to comment.