Code Monkey home page Code Monkey logo

cyrus's Introduction

Cyrus

GitHub package.json version Commitizen friendly code style: prettier GitHub

Pubsub library for Postgres.

Install

npm install cyrus-rx

Usage

Options

  • appName (required): string
    • name of the application (used for logging)
  • user (optional): string
    • option for Postgres Pool Connection
  • password (optional): string
    • option for Postgres Pool Connection
  • host (optional): string
    • option for Postgres Pool Connection
  • port (optional): number
    • option for Postgres Pool Connection
  • database (optional): string
    • option for Postgres Pool Connection
import cyrus from 'cyrus-rx';

const notifier = cyrus({ appName: 'cyrus-example' });

// It needs to be connected before used
const connectedSuccessfully = await notifier.connect();

if (connectedSuccessfully) {
  // Create an observable to with a channel to listen to
  // Rx.Observable
  const observable$ = notifier.on('example-channel');

  // Sends this to postgres
  // The observable will emit this message.
  notifier.notify('example-channel', 'example-message');
}

// disconnect from the database by ending the pool
notifier.disconnect()

cyrus's People

Contributors

dependabot[bot] avatar jamesteague avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.