# postgres-pool-pmb

> Nicer API for the parts of the `pg` postgres module that I actually use. Mostly renamed config keys for pool config

Latest version **0.1.2** (published 2022-04-11) · ISC license · 0 weekly downloads

## Install

```sh
npm install postgres-pool-pmb
pnpm add postgres-pool-pmb
yarn add postgres-pool-pmb
bun add postgres-pool-pmb
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2022-04-11 |
| First published | 2022-04-04 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=16.0.0 |
| Dependencies | 5 |
| Unpacked size | 13.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | M.K. |
| Maintainers | mk-pmb |
| Keywords | pg, postgres |

## Links

- npm: https://www.npmjs.com/package/postgres-pool-pmb
- Repository: https://github.com/mk-pmb/postgres-pool-pmb-js
- Homepage: https://github.com/mk-pmb/postgres-pool-pmb-js/#readme
- Issues: https://github.com/mk-pmb/postgres-pool-pmb-js/issues
- npm.io page: https://npm.io/package/postgres-pool-pmb

## Dependencies (5)

- [vtry](https://npm.io/package/vtry.md) ^1.0.8
- [getown](https://npm.io/package/getown.md) ^1.0.0
- [objpop](https://npm.io/package/objpop.md) ^0.3.1
- [typechecks-pmb](https://npm.io/package/typechecks-pmb.md) ^0.200620.4
- [timestring-notsep](https://npm.io/package/timestring-notsep.md) ^1.0.2

## Recent versions

- 0.1.2 (latest) — 2022-04-11
- 0.1.1 — 2022-04-04
- 0.1.0 — 2022-04-04

## README

<!--#echo json="package.json" key="name" underline="=" -->
postgres-pool-pmb
=================
<!--/#echo -->

<!--#echo json="package.json" key="description" -->
Nicer API for the parts of the `pg` postgres module that I actually use.
Mostly renamed config keys for pool config
<!--/#echo -->



API
---

This module exports an object that holds these functions:

### initPool(opt)

Returns a promise that will be resolved when we get
positive confirmation that the pool accepted our login
and has passed a trivial health check.

`opt` is an optional options object that supports these mostly optional keys:

* `pgLib` (required):
  Your database driver object. It should have an API compatible
  to the Promise-ing parts of the interface of package `pg` from
  [brianc's `node-postgres`](https://github.com/brianc/node-postgres).
* `poolCfg`: An options object with config details for the actual pool.
  Supported options (all optional) can be found in
  [`src/initPool.opts.mjs`](src/initPool.opts.mjs).



Usage
-----

see [test/usage.mjs](test/usage.mjs).


<!--#toc stop="scan" -->



Known issues
------------

* Needs more/better tests and docs.




&nbsp;


License
-------
<!--#echo json="package.json" key=".license" -->
ISC
<!--/#echo -->

---
_Source: https://npm.io/package/postgres-pool-pmb · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._