Giter VIP home page Giter VIP logo

pika-ts's Introduction

Pika

A opinionated amqplib wrapper to make it easier to create evented systems.

Example

import { Pika } from "pika";

const pika = await Pika.connect("YOUR_RABBITMQ_URL");

// Consume example
pika.on("exchange", "routingKey", async (msg) => {
  // Do something with msg
});

// Publish Example
await pika.publish("exchange", "routingKey", { hello: "world" });

Typed Example

You can also restrict exchanges and routingKeys to your own types.

import { Pika } from "pika";

type Exchanges = "hello" | "world";
type Events = "hello.world" | "world.hello";

const pika = new Pika.connect<Exchanges, Events>("YOUR_RABBITMQ_URL");

// this won't compile now
pika.on("exchange", "routingKey", async (msg) => {});

// You must obey your Exchanges and Event types
// the  msg can also be typed
pika.on("hello", "hello.world", async (msg: MyType) => {});

// Publish Example
pika.publish("world", "world.hello", { hello: "world" });

In Memory

If we want to use Pika in memory, maybe in tests, we can do it like this:

import { InMemoryPika } from "pika";


const pika = new InMemoryPika();

pika.on("hello", "hello.world", async (msg: MyType) => {});
pika.publish("world", "world.hello", { hello: "world" });
`

pika-ts's People

Contributors

mbcrocci avatar

Watchers

 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.