underflag-postgresql

Postgresql Provider

This is a Postgresql provider for underflag (feature flag/feature toggle)

Install

Using npm:

npm install underflag-postgresql

Using yarn:

yarn add underflag-postgresql

How to use

Import the underflag and prepare to load data provider

import { Underflag } from "underflag";
import { PostgresqlDataProvider } from "underflag-postgresql";
import { Client } from 'pg';

const client = new Client({/* config... */})
await client.connect();
const dataProvider = new PostgresqlDataProvider({ client });
const underflag = new Underflag({ dataProvider });
if (await underflag.isOn("feature")) {
    // ...
}

Attention: Do not forget of create the features table in postgresql with the key and value columns.

Example of table:

CREATE TABLE features (
    id serial4 NOT NULL,
    "key" varchar(200) NOT NULL,
    value varchar(1000) NULL,
    description varchar(200) NULL,
    created_at timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
    CONSTRAINT features_pkey PRIMARY KEY (id)
);
CREATE UNIQUE INDEX features_key_idx ON features USING btree (key);

Know more on underflag npm page

License

MIT