https://github.com/deepal/node-tiny-message
A Simple Message Generator
https://github.com/deepal/node-tiny-message
Last synced: 11 months ago
JSON representation
A Simple Message Generator
- Host: GitHub
- URL: https://github.com/deepal/node-tiny-message
- Owner: deepal
- Created: 2017-01-22T11:59:36.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-11-14T18:15:58.000Z (over 7 years ago)
- Last Synced: 2025-07-22T13:05:39.460Z (11 months ago)
- Language: JavaScript
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
#node-tiny-message
## A Simple Message Generator
This is a simple message factory to create success/error messages to be passed among NodeJS functions. This is useful to wrap low level errors/messages and pass them to the top of the stack via callbacks/promises.
####Success Message
Syntax -
```
require('tiny-message').success(,,);
```
Example -
```
const message = require('tiny-message');
const successMsg = message.success('This is a simple success message', {test:123}, 100);
```
Success message will have following properties:
* **success** - success status (always defaults to **true**)
* **message** - success message string
* **data** - Additional data provided
####Error Message
Syntax -
```
require('tiny-message').error(,,);
```
Example -
```
const message = require('tiny-message');
const errorMsg = message.error('This is a simple error message', new Error('test'), 100);
```
Success message will have following properties:
* **success** - success status (always defaults to **false**)
* **message** - error message string
* **data** - Additional data/error object provided
####Tests
```
npm test
```