pg-gql-pubsub

Full type-safe PostgreSQL PubSub (using NOTIFY and LISTEN) with smart reconnection and specially designed for GraphQL API Usage, powered mainly by the great library: @imqueue/pg-pubsub

Check graphql-ez 💯

pnpm add pg-gql-pubsub

yarn add pg-gql-pubsub

npm install pg-gql-pubsub

Usage

import { CreatePubSub } from "pg-gql-pubsub";

declare module "pg-gql-pubsub" {
  interface Channels {
    notification: string;
  }
}

export const pubSub = CreatePubSub({
  connectionString: process.env.DATABASE_URL,
});

// ...

pubSub.subscribe("notification").then(async (iterator) => {
  for await (const data of iterator) {
    // data <=> string
    console.log(data);
  }
});

// ...

pubSub.publish("notification", "Hello World");

With GraphQL Code Generator

// Assumming `type Subscription { notification: String! }`

import type { Subscription } from "../generated/graphql.ts";
import { CreatePubSub } from "pg-gql-pubsub";

type PubSubData = { [k in keyof Subscription]: Pick<Subscription, k> };

declare module "pg-gql-pubsub" {
  interface Channels extends PubSubData {}
}

export const pubSub = CreatePubSub({
  connectionString: process.env.DATABASE_URL,
});

// ...

const resolvers = {
  Subscription: {
    notification: {
      subscribe(_root, _args, { pubSub }) {
        // Assumming you already added the pubSub to your context
        return pubSub.subscribe("notification");
      },
    },
  },
};

for await (const data of pubSub.subscribe("notification")) {
  // data <=> { notification: "Hello World" }
  console.log(data);
}

// ...

pubSub.publish("notification", { notification: "Hello World" });