klart v0.2.0

Klart

About

Klart is a wrapper around node-postgres. It provides a simple interface to make queries towards a PostgreSQL database. Feel free to reach out with any suggestions on how it could be expanded!

Development Setup

The best way to get a working dev environment is to run use docker compose. | command | purpose | | ---------------------- | ------------------------------------- | | docker-comopse up -d | start environment | | yarn ssh | enter the dev environment | | docker-compose down | tear the development environment down |

Installation

yarn add klart

How to use

All examples use a common Dog-type, looking like this:

type Dog = { name: string; age: number };

Get the first row

import { first } from 'klart';

const fluffy = await first<Dog>('SELECT * FROM dogs WHERE name = $1', ['fluffy']);
console.log(`Retrieved a dog called ${fluffy.name} aged ${fluffy.age}`);

Get all rows

import { rows } from 'klart';

const dogs = await rows<Dog>('SELECT * FROM dogs');
dogs.forEach((dog) => {
  console.log(`Retrieved a dog called ${dog.name} aged ${dog.age}`);
});

Just execute a query

import { run } from 'klart';

//NOTE: no result returned when using `run`
await run('INSERT INTO dogs (name, age) VALUES($1, $2)', ['Fido', 5]);

Configuration

Klart, like node-postgres, picks up the same environment variables as lipq. If you want to ovverride this, you can import withConfiguration from Klart and use that instead (see example below). As Klart really just hands of configuration to node-postgres, details on this page is the best source of information for configuration.

import { withConfiguration } from 'klart';
const { first, rows } = withConfiguration({
  user: 'dbuser',
  host: 'database.server.com',
  database: 'mydb',
  password: 'secretpassword',
  port: 3211,
});