Quick Postgres

A fast & simple key | value storage for postgres.

Inspired by quick.db

Features

• Typed
• Incredibly similar to quick.db
• Beginner Friendly

All issues are welcomed!

Usage

import QuickPg from 'quick-postgres';

const db = new QuickPg({
    table:"test",
    poolOptions: {
   host: 'localhost',
   user: 'postgres',
   password: '1234',
   database: 'myDatabase'
    }
})

console.log(db.set<number>("sword", 2))
console.log(db.get("sword"))

API Reference

Classes

Functions

QuickPg

QuickPg This is the main class for the QuickPostgres library.

Kind: global class

new QuickPg(qpOps)

| Param | Description | | --- | --- | | qpOps | Specifies the QuickPostgres Options. Check out https://node-postgres.com/api/pool for pool configurations. |

exists

Checks if a key exists or not.(key) ⇒ Kind: global function
Returns: boolean

| Param | Description | | --- | --- | | key | the key that you want to check if exists. |

set

Sets a value to a key in the table. Returns void or boolean depending on the success.(key, value) ⇒ Kind: global function
Returns: void | boolean

| Param | Description | | --- | --- | | key | The key you want to set the value in. | | value | The value of the key. |

get

Returns the value of the specified key. The value maybe of any type depending upon the set type.(key) ⇒ Kind: global function
Returns: Promise

| Param | Description | | --- | --- | | key | The key from where you want to get the value. |

delete

Deletes a key and value from the table.(key) ⇒ Kind: global function
Returns: Promise

| Param | Description | | --- | --- | | key | The key who's content is to be deleted. |

all

Returns all the contents in a table. Specifically key value pairs.() ⇒ Kind: global function
Returns: Promise

Maintainer

rhydderchc