https://github.com/ghaiklor/node-print-message
Node.js module for printing out beautiful messages in console
https://github.com/ghaiklor/node-print-message
beautiful-messages border console javascript nodejs
Last synced: 9 months ago
JSON representation
Node.js module for printing out beautiful messages in console
- Host: GitHub
- URL: https://github.com/ghaiklor/node-print-message
- Owner: ghaiklor
- License: mit
- Archived: true
- Created: 2015-02-18T15:46:13.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2025-02-19T14:57:46.000Z (about 1 year ago)
- Last Synced: 2025-06-23T06:17:19.114Z (10 months ago)
- Topics: beautiful-messages, border, console, javascript, nodejs
- Language: JavaScript
- Homepage:
- Size: 681 KB
- Stars: 21
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# print-message
[](https://github.com/ghaiklor)
[](https://twitter.com/ghaiklor)
Node.js module for printing out beautiful messages in console.
## Installation
Install `print-message` module:
```bash
npm install --save print-message
```
## Getting Started
Require `print-message` module and call a function:
```javascript
const printMessage = require('print-message');
printMessage(['Hello, everyone']);
```
## Options
You can set your own options for border.
```javascript
const printMessage = require('print-message');
printMessage([
"You can set your own options for border",
"Options below is default options"
], {
border: true, // Enable border
color: 'default', // Default text color from console
borderColor: 'yellow', // Border color is yellow
borderSymbol: '─', // Symbol that uses for border
sideSymbol: '│', // Symbol that uses for side separators
leftTopSymbol: '┌', // Symbol that uses for left top corner
leftBottomSymbol: '└', // Symbol that uses for left bottom corner
rightTopSymbol: '┐', // Symbol that uses for right top corner
rightBottomSymbol: '┘', // Symbol that uses for right bottom corner
marginTop: 0, // Margin before border is begins
marginBottom: 0, // Margin after border is ends
paddingTop: 0, // Padding after border begins
paddingBottom: 0, // Padding before border ends
printFn: process.stdout.write.bind(process.stdout) // Custom function for print generated message
});
```
## Examples
### Print simple message
```javascript
const printMessage = require('print-message');
printMessage([
"Hello",
"It's the huge world",
"But width can be calculated automatically"
]);
```
### Print message with custom options
```javascript
const printMessage = require('print-message');
printMessage(['You can set your own options for border'], {
border: true, // Enable border
color: 'green', // Text color
borderColor: 'blue', // Border color is blue
borderSymbol: '│', // Symbol that uses for border
sideSymbol: '│', // Symbol that uses for side separators
leftTopSymbol: '└', // Symbol for left top corner
leftBottomSymbol: '┌', // Symbol for left bottom corner
rightTopSymbol: '┘', // Symbol for right top corner
rightBottomSymbol: '┐', // Symbol for right bottom corner
marginTop: 3, // Margin before border is begins
marginBottom: 3, // Margin after border is end
paddingTop: 2, // Padding top after border begins
paddingBottom: 2, // Padding bottom before border ends
printFn: function (message) {
// Custom function that accepts generated message as argument and print it
process.stdout.write(message);
}
});
```
### Print message without border
```javascript
const printMessage = require('print-message');
printMessage([
"This message will be without border",
"But you still can set marginTop and marginBottom"
], {
border: false,
marginTop: 3,
marginBottom: 3
});
```
## License
[The MIT License (MIT)](./LICENSE)