npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

fastify-slonik

v2.0.0

Published

Fastify Slonik Plugin

Downloads

337

Readme

Fastify Slonik

A Fastify plugin that uses the PostgreSQL client, Slonik. Slonik abstracts repeating code patterns, protects against unsafe connection handling and value interpolation, and provides a rich debugging experience.

For fastify v4, use latest version, for fastify v3, use v1.4x.

NPM downloads npm node-current

Usage

Yarn

yarn add fastify-slonik

NPM

npm i fastify-slonik

PNPM

pnpm i fastify-slonik

Example:

Import the Plugin

Both default export and named export option is available.

// index.js
const { fastifySlonik } = require("fastify-slonik");

// Or
const fastifySlonik = require("fastify-slonik");

or

import { fastifySlonik } from "fastify-slonik";

// or

import fastifySlonik from "fastify-slonik";

Register the Plugin

// register fastify-slonik
try {
  await app.register(fastifySlonik, {
    connectionString: process.env.DATABASE_URL,
  });
} catch (err) {
  console.log("🔴 Failed to connect, check your Connection string");
  throw new Error(err);
}

Using the plugin through decorators

FastifyInstance (this) and FastifyRequest (request) have been decorated with slonik and sql. Use it the way you want.

// setup test route
// The decorated Fastify server is bound to this in route route handlers:
fastify.get('/users', async function (this, request, reply) {
  const { sql, slonik } = this;
  const queryText = sql`SELECT * FROM users WHERE user_id = 1`
  const user = await slonik.query(queryText)

  reply.send(user)
}

Another way to access the Slonik and SQL decorator is through the request object-

fastify.get('/users', async function (request, reply) {
  const { sql, slonik } = request
  const queryText = sql`SELECT * FROM users WHERE user_id = 1`

  const user = await slonik.query(queryText)
  reply.send(user)
}

Docs for This

View Slonik API for details.

Development and Testing

Tap is used for testing. Use pnpm test command to run tests.

Docker approach

$ docker-compose up

To run the tests:

  • Create .env cp .env.example .env
$ yarn test

Custom Postgres approach

  1. Set up a database of your choice in a postgres server of your choice
  2. Create the required table using
    CREATE TABLE users(id serial PRIMARY KEY, username VARCHAR (50) NOT NULL);
  3. Create .env cp .env.example .env and update environment variables accordingly

License

Licensed under MIT.