hex@v0.3 | Deno

Function abstraction framework for better portability between platforms. Write your code once in functional approach, then run on mainstream environments such as cli, bot platforms, cloud-function runtimes and web apis.

This project is in early stages of its development. Descriptions or instructions are not mature yet as well as the project itself.

Roadmap

MVP

Next Milestones

Usage

Basic

import { results, createRuntime, cli } from "https://deno.land/x/hex/mod.ts";

function main(input) {
  const to = input.parameters[0] ?? "world";
  const message = `hello ${to}`;

  return results.text(message);
}

// will be removed in future versions
// propably will be replaced w/ export
const runtime = createRuntime(cli);
runtime.execute(main);

With Middlewares

import { composer, results, createRuntime, cli } from "https://deno.land/x/hex/mod.ts";

function initMiddleware(input, context, next) {
  context.vars.number = 1;

  return next();
}

function validationMiddleware(input, context, next) {
  if (input.parameters[0] === undefined) {
    return results.error(
      "parameter is not specified",
      new Error("parameter is not specified"),
    );
  }

  return next();
}

function main(input, context) {
  const message = `hello ${context.vars.number} ${input.parameters[0]}`;

  return results.text(message);
}

const composed = composer(initMiddleware, validationMiddleware, main);

// will be removed in future versions
// propably will be replaced w/ export
const runtime = createRuntime(cli);
runtime.execute(composed);

Quick start

Clone this git repo git clone https://github.com/eserozvataf/hex-functions.git - and checkout the tagged release you’d like to use.

$ deno run samples/cli/basic.ts eser

hello eser

Todo List

Requirements

License

Contributing

It is publicly open for any contribution. Bugfixes, new features and extra modules are welcome.

✖️ hex-functions