An example hello world module to start your work on.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
test
.editorconfig
.eslintrc
.gitignore
LICENSE
README.md
package-lock.json
package.json

README.md

A scramjet-hello-module

An example hello world scramjet module to start your work on.

Once you provide it with a stream of object with names, it'll say hello to each name.

Usage

The stream is best used with scramjet, here's how you use it:

scramjet
    .from(stream)
    .use("scramjet-hello-module", "Hi {}!");

The above is the same as writing the same without scramjet:

const helloStream = require("scramjet-hello-module");

const data = new ReadableStream();
data.write("Mike");
data.write("Alice");
data.end("Sam");

const out = helloStream(data, "Hello {}!\n");

out.pipe(process.stdout);
// Hello Mike!
// Hello Alice!
// Hello Sam!