# StringJs

StringJs is a library that introduces useful and easy functions to manipulate strings in JavaScript

 

![example workflow](https://github.com/mattiaerli97/stringjs/actions/workflows/main.yml/badge.svg)
[![codecov](https://codecov.io/gh/mattiaerli97/stringjs/branch/master/graph/badge.svg?token=I5B2S8N1BW)](https://codecov.io/gh/mattiaerli97/stringjs)
![dependencies](https://status.david-dm.org/gh/mattiaerli97/stringjs.svg)
![devdependencies](https://status.david-dm.org/gh/mattiaerli97/stringjs.svg?type=dev)

 

## Features

- import this package in your project
- choose a string and the right function in this library
- now you have your formatted string!

 

## Installation

<code>npm install --save stringjs</code>

or

<code>yarn add stringjs</code>

&nbsp;

## How To Import and Use

<code>const stringjs = require('stringjs')</code>  

or

<code>import stringjs from 'stringjs'</code>  

&nbsp;

After this import you can use any function provided in the [section below](#Functions-and-Methods) with this call structure  

<code>stringjs.capitalizeFirst()</code>

&nbsp;

## Functions and Methods

| Method | Input | Output |
| ------ | ----- | ------ |
| [capitalizeFirst](#capitalizeFirst) | a <code>string</code> | The string with the first letter capitalized |
| [capitalizeLast](#capitalizeLast) | a <code>string</code> | The string with the last letter capitalized |
| [capitalizeByIndex](#capitalizeByIndex) | a <code>string</code> and a parameter of type <code>number</code>, <code>array</code> or <code>function<code> | The string with the letter in the index provided (zero-based) capitalized. <ul><li>In case the provided second parameter is an <code>array</code> of integers, the string is capitalized in all the index positions</li><li>In case the provided second parameter is a <code>function</code>, the function is used to test if the index matches the boolean condition of the function and then makes that character in uppercase</li></ul> If the index is greater then the string's length, returns the string as provided |
| [capitalizeByLetter](#capitalizeByLetter) | a <code>string</code> and a parameter of type <code>number</code>, <code>array</code> or <code>function<code> | Converts in uppercase all the occurencies of the letter provided <ul><li>In case the provided second parameter is an <code>array</code> of characters, all the letters included in the array are converted in uppercase</li><li>In case the provided second parameter is a <code>function</code>, the function is used to test if the letter matches the boolean condition of the function and then makes that characters in uppercase</li></ul> |
| [deCapitalizeFirst](#deCapitalizeFirst) | a <code>string</code> | The string with the first letter decapitalized |
| [deCapitalizeLast](#deCapitalizeLast) | a <code>string</code> | The string with the last letter decapitalized |
| [deCapitalizeByIndex](#deCapitalizeByIndex) | a <code>string</code> and a parameter of type <code>number</code>, <code>array</code> or <code>function<code> | The string with the letter in the index provided (zero-based) capitalized. <ul><li>In case the provided second parameter is an <code>array</code> of integers, the string is decapitalized in all the index positions</li><li>In case the provided second parameter is a <code>function</code>, the function is used to test if the index matches the boolean condition of the function and then makes that character in lowercase</li></ul> If the index is greater then the string's length, returns the string as provided |
| [deCapitalizeByLetter](#deCapitalizeByLetter) | a <code>string</code> and a parameter of type <code>number</code>, <code>array</code> or <code>function<code> | Converts in lowercase all the occurencies of the letter provided <ul><li>In case the provided second parameter is an <code>array</code> of characters, all the letters included in the array are converted in lowercase</li><li>In case the provided second parameter is a <code>function</code>, the function is used to test if the letter matches the boolean condition of the function and then makes that characters in lowercase</li></ul> |

&nbsp;

## Working Examples
### capitalizeFirst
```js
stringjs.capitalizeFirst('my cool string')

// OUTPUT: My cool string
```

### capitalizeLast
```js
stringjs.capitalizeLast('my cool string')

// OUTPUT: my cool strinG
```

### capitalizeByIndex
```js
stringjs.capitalizeByIndex('my cool string', 3)

// OUTPUT: my Cool string



stringjs.capitalizeByIndex('my cool string', 50)

// OUTPUT: my cool string



stringjs.capitalizeByIndex('my cool string', [0, 1, 5, 20, 6, 13])

// OUTPUT: MY coOL strinG



stringjs.capitalizeByIndex('my cool string', (i) => { return i === 3 || i === 5 })

// OUTPUT: my CoOl string
```

### capitalizeByLetter
```js
stringjs.capitalizeByLetter('test', 't')

// OUTPUT: TesT



stringjs.capitalizeByLetter('test', ['t', 'e'])

// OUTPUT: TEsT



stringjs.capitalizeByLetter('test', (l) => { return l === 'e' || l === 's' })

// OUTPUT: tESt
```

### deCapitalizeFirst
```js
stringjs.deCapitalizeFirst('TEST')

// OUTPUT: tEST
```

### deCapitalizeLast
```js
stringjs.deCapitalizeLast('TEST')

// OUTPUT: TESt
```

### deCapitalizeByIndex
```js
stringjs.deCapitalizeByIndex('MY COOL STRING', 3)

// OUTPUT: MY cOOL STRING



stringjs.deCapitalizeByIndex('MY COOL STRING', 50)

// OUTPUT: MY COOL STRING



stringjs.deCapitalizeByIndex('MY COOL STRING', [0, 1, 5, 20, 6, 13])

// OUTPUT: my COol STRINg



stringjs.deCapitalizeByIndex('MY COOL STRING', (i) => { return i === 3 || i === 5 })

// OUTPUT: MY cOoL STRING
```

### deCapitalizeByLetter
```js
stringjs.deCapitalizeByLetter('TEST', 'T')

// OUTPUT: tESt



stringjs.deCapitalizeByLetter('TEST', ['T', 'E'])

// OUTPUT: teSt



stringjs.deCapitalizeByLetter('TEST', (l) => { return l === 'E' || l === 'S' })

// OUTPUT: TesT
```

&nbsp;

## License

MIT