┓┏┓┏┓┃
┛┗┛┗┛┃ ⟍ ○⟋
┓┏┓┏┓┃   ∕    jumper
┛┗┛┗┛┃ ノ)     message
┓┏┓┏┓┃
┃┃┃┃┃┃
┻┻┻┻┻┻

Usage

import jumperMessage from 'jumper-message';

console.log(jumperMessage('message'));

API

jumperMessage(message, [options])

message

Type: string

The string to use as the message.

options

Type: Object

buildingStyle

Type: string
Set the style of the bulding to a chalk style. Defaults to gray.

compact

Type: boolean
Remove the padding between the message lines. Defaults to false.

extraFloors

Type: Number
Add extra floors to the building below the message. Defaults to 0.

gradient

Type: string
Set the style of the message to be a gradient, using the built-in gradients from gradient-string. Overrides the color set with messageColor. Defaults to pastel if the specified gradient isn’t valid.

messageStyle

Type: string
Set the style of the message to a chalk style. Defaults to bold.white. Overridden when the gradient option is used.

personStyle

Type: string
Set the style of the jumper to a chalk style. Defaults to white.

Related

• jumper-message-cli - CLI for this module
• chalk
• gradient-string
• Friday deploy script for Capistrano

License

MIT © Brad Dougherty