Messageflow

Table of contents

• Pre-requisite
• Setup
  • Install
  • Usage
    • Node.js
    • Native ES modules or TypeScript
• API Reference
  • greeting(name)
  • greetingSync(name)
• License

Pre-requisites

• Node.js >= 8.9.0
• NPM >= 5.5.1 (NPM comes with Node.js so there is no need to install separately.)

Setup

Install

# Install via NPM
$ npm install --save messageflow

Usage

Node.js

const greeting = require('messageflow');

Native ES modules or TypeScript

import greeting from 'messageflow';

API Reference

greeting(name)

• name <string> Name of the person to greet at.
• returns: <Promise<string>> Promise which resolves with a greeting message.

greetingSync(name)

This methods works the same as greeting(name) except that this is the synchronous version.

License

MIT License © Rong Sen Ng