message-flow
Better greeting message
!NPMnodei-badgenodei-url
!Build Statustravis-badgetravis-url !Versionversion-badgeversion-url !Downloadsdownloads-badgedownloads-url !MIT Licensemit-license-badgemit-license-url !Dependency Statusdaviddm-badgedaviddm-url !NSP Statusnsp-badgensp-url
!Code of Conductcoc-badgecoc-url
!codebeat-badgecodebeat-url !codacy-badgecodacy-url !inch-badgeinch-url
Messageflow
Table of contents
- Install - Usage- [Node.js](#nodejs)
- [Native ES modules or TypeScript](#native-es-modules-or-typescript)
- greeting(name)
- greetingSync(name)Pre-requisites
- Node.jsnode-js-url >= 8.9.0
- NPMnpm-url >= 5.5.1 (NPMnpm-url comes with Node.jsnode-js-url so there is no need to install separately.)
Setup
Install
# Install via NPM
$ npm install --save message-flow
Usage
Node.js
const greeting = require('message-flow');
Native ES modules or TypeScript
import greeting from 'message-flow';
API Reference
greeting(name)
- name <stringstring-mdn-url> Name of the person to greet at. - returns: <Promisepromise-mdn-url<stringstring-mdn-url>> Promise which resolves with a greeting message.greetingSync(name)
This methods works the same asgreeting(name)
except that this is the synchronous version.