frame-of-mind

frame-of-mind adds a frame around strings.

yarn add -E frame-of-mind

Table Of Contents

• Table Of Contents
• API
• frameOfMind(string: string, options?: Config): string
  • _frameOfMind.Config
• Copyright

API

The package is available by importing its default function:

import frameOfMind from 'frame-of-mind'

frameOfMind(  string: string,  options?: Config,): string

This function will add a frame around strings with single or multiple lines.

_frameOfMind.Config: Options for the program.

| Name | Type | Description | Default | | ------- | --------------- | --------------------------- | ------- | | padding | number | The left and right padding. | 1 |

import frameOfMind from 'frame-of-mind'

const res = frameOfMind(
  `There are thousands upon thousands of students
who have practised meditation and obtained its fruits.
Do not doubt its possibilities because of the simplicity of the method.
If you can not find the truth right where you are,
where else do you expect to find it?`
)

┌─────────────────────────────────────────────────────────────────────────┐
│ There are thousands upon thousands of students                          │
│ who have practised meditation and obtained its fruits.                  │
│ Do not doubt its possibilities because of the simplicity of the method. │
│ If you can not find the truth right where you are,                      │
│ where else do you expect to find it?                                    │
└─────────────────────────────────────────────────────────────────────────┘

Copyright