# btxt

> Btxt is all about customized letters!

Latest version **1.3.8** (published 2019-02-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install btxt
pnpm add btxt
yarn add btxt
bun add btxt
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.8 |
| Published | 2019-02-01 |
| First published | 2018-08-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 14.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Hota |
| Maintainers | hota |
| Keywords | npm, nodejs, javascript, btxt |

## Links

- npm: https://www.npmjs.com/package/btxt
- Repository: https://github.com/LeeeRoux/btxt
- Homepage: https://github.com/LeeeRoux/btxt#readme
- Issues: https://github.com/LeeeRoux/btxt/issues
- npm.io page: https://npm.io/package/btxt

## Recent versions

- 1.3.8 (latest) — 2019-02-01
- 1.3.7 — 2018-12-04
- 1.3.6 — 2018-11-16
- 1.3.5 — 2018-11-01
- 1.3.4 — 2018-10-22
- 1.3.3 — 2018-10-20
- 1.3.2 — 2018-10-19
- 1.3.1 — 2018-10-19
- 1.3.0 — 2018-10-19
- 1.2.2 — 2018-10-06
- 1.2.1-PRE — 2018-10-06
- 1.2.1 — 2018-10-06
- 1.2.0 — 2018-08-23
- 1.1.0 — 2018-08-23
- 1.0.0 — 2018-08-23

## README

Btxt Module [![Build Status](https://travis-ci.org/LeeeRoux/btxt.svg?branch=master-branch)](https://travis-ci.org/LeeeRoux/btxt) [![Version](https://img.shields.io/badge/version-1.3.6-blue.svg)](https://www.npmjs.com/package/btxt?activeTab=versions) 
===========
Btxt is a very-tiny module for more features to improve your Style
> npm i btxt@latest

#### Properties
* **btxt** *Method*<br>
 Convert a String into a Customized String
- Argument 
  * `txt` String<br>
 Returns `String`
```js
const b = require("btxt");
 b.btxt("Hello World");
//"Ħȩŀḹ๑ Ŵ๏ṝḹժ!"
```
* **compare** Method <br>
 Compare a String with an Array of string to find the most closed value
- Arguments 
  * `word` String
  * `toCompareWith` Array<br>
Returns `String` || `null` Incase there was no any similar value
```js
 const b = require("btxt");
b.compare("hulle wurld", ["hello", "boo", "Hello world", "baz", "ello world"])
//"Hello world"
```
* **toLatin** *Method*<br>
 Calculate a number into Latin
- Argument
  * `number` Number<br>
Returns `String`
```js
const b = require('btxt');
 b.toLatin(1540);
//"MDXL"
```
* **keyGenerator** *Class*<br>
 Generate a random key that contains characters and numbers
- Argument
   * `keyLength` Number *Optional* default = `15` You can also set the key length directly via the prop `.keyLength`<br>
Returns `String`
```js
const b = require('btxt');
 var gen = new b.keyGenerator();
gen.generate();
//"634h9jTd92X9d2M"
```
* **calculateLatin** *Method*<br>
 Calculate a latin number 
- Argument
   * `str` String, Latin Number<br>
Returns `Number`<br>
Throw an Error if the number was invalid
```js
const b = require('btxt');
 b.calculateLatin("MDXIV")
//1514
```
* **between** *Method*<br>
 Gets a string between Argument `qu1` and `qu2`<br>
- Arguments
  * `str` String.
  * `qu1` String. Default = `"`
  * `qu2` String. Default = `qu2`<br>
  Returns Array | null.<br>
e.g.
```js
 const b = require('btxt');
b.between("{Hello}{World}{", "{", "}");
// ["Hello", "World"]
``` 
## Browser Version
```html
<script src='https://raw.githubusercontent.com/LeeeRoux/btxt/master/bin/btxt-browser.js'></script>
```

---
_Source: https://npm.io/package/btxt · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._