beamed v0.3.0

beamed

A blazing fast, slim communication protocol for NodeJS IPC.

Features

• A lightweight protocol minimizes network traffic and provides high processing performance
• The TypeScript API enables you to specify strictly typed endpoints and reuse the same type definitions on client and server side
• Support for Unix, Windows, TCP and TLS sockets
• Requesting, messaging and publish / subscribe
• Send any payload (objects, buffers and strings)
• No third party dependencies

Example

shared.ts

enum AuthTopics {
  login, // can be strings or numbers
}
interface AuthApi {
  [AuthTopics.login]: {
    req: Credentials;
    res: User;
  };
}

server.ts

import { createServer } from "beamed";
import { AuthApi, AuthTopics } from "./shared";

const bs = createServer<AuthApi>()
  .onRequest(AuthTopics.login, authenticate)
  .listen("/tmp/auth-test");

client.ts

import { connect } from "beamed";
import { AuthApi, AuthTopics } from "./shared";

const bc = connect<AuthApi>("/tmp/auth-test");
bc.request(AuthTopics.login, new Credentials("user", "p4ssw0rd")).then((user) =>
  console.log(user)
);

Protocol

Message types (Not completely implementing yet).

Where the tokens have the following format