new PgChannel()
- Source:
Methods
endHandler(endHandler) → {PgChannel}
Set an handler to be called when no more notifications will be received.
Parameters:
Name | Type | Description |
---|---|---|
endHandler |
function | the handler |
- Source:
Returns:
a reference to this, so the API can be used fluently
- Type
- PgChannel
exceptionHandler(handler) → {PgChannel}
Parameters:
Name | Type | Description |
---|---|---|
handler |
function |
- Source:
Returns:
- Type
- PgChannel
fetch(arg0) → {ReadStream}
Parameters:
Name | Type | Description |
---|---|---|
arg0 |
number |
- Source:
Returns:
- Type
- ReadStream
handler(handler) → {PgChannel}
Set or unset an handler to be called when a the channel is notified by Postgres.
- when the handler is set, the subscriber sends a
LISTEN
command if needed - when the handler is unset, the subscriber sends a
UNLISTEN
command if needed
Parameters:
Name | Type | Description |
---|---|---|
handler |
function | the handler |
- Source:
Returns:
a reference to this, so the API can be used fluently
- Type
- PgChannel
pause() → {PgChannel}
Pause the channel, all notifications are discarded.
- Source:
Returns:
a reference to this, so the API can be used fluently
- Type
- PgChannel
resume() → {PgChannel}
Resume the channel.
- Source:
Returns:
a reference to this, so the API can be used fluently
- Type
- PgChannel
subscribeHandler(handler) → {PgChannel}
Set an handler called when the the channel get subscribed.
Parameters:
Name | Type | Description |
---|---|---|
handler |
function | the handler |
- Source:
Returns:
a reference to this, so the API can be used fluently
- Type
- PgChannel