Skip to content

GreepTheSheep/auto-line-breaks

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

auto-line-breaks

A npm package that adds automatically line breaks in a string

Why?

Because I using it for adding lines in a discord.js bot that makes text in a part of a picture

What does it does?

The called function will use your string, split then put in a array of strings, then the array will be transformed into a string and use join() to be a line break

Utilisation:

Simply call the module with the require:

var autoLineBreak = require('auto-line-breaks');

Then use it as a function:

// Make a text
var text = "Hello I'm a text, and I love you so much!";
// Then define the length of a line by defining a number of characters in a line
var lineLength = 10

console.log(text) // Output: "Hello I'm a text, and I love you so much!"

var result = autoLineBreak(text, lineLength) // calls the function and store in a variable

console.log(result)
/* Output:
"Hello I'm a
text, and -
I love you -
so much!"
*/

Usage example

soon™️

Run an example

Downlowd the repo, then execute npm run example on it

Contributing

You're clairy welcome! Join the github repo