johngrimm-utils/README.md

Module created for facilitated your life ;) Bringing some native PHP modules to the NODE and Create new modules

<h1 align="center">Welcome to johngrimm-utils 👋</h1>
<p>
  <a href="https://www.npmjs.com/package/johngrimm-utils" target="_blank">
    <img alt="Version" src="https://img.shields.io/npm/v/johngrimm-utils.svg">
  </a>
  <a href="LICENSE" target="_blank">
    <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
  </a>
</p>

> Module created for facilitated your life ;) Bringing some native PHP modules to the NODE and Create new modules

## Install

```sh
$ npm i johngrimm-utils -s
```

## Usage

### IMPORT ALL FUNCTIONS

```js
const { GetStr, sleep, substr_count, curl, gerarCpf, gift, include, rand, randomizador, proxy, proxy1 } = require("johngrimm-utils")
```

### FUNCTIONS

* [bin](#bin): function to check bin
* [curl](#curl): Function async/await for famous Curl (for request in web or applications)
* [dados](#dados): function for Generate Person BR
* [gerarCpf](#GerarCpf): function for generate CPF valid
* [GetStr](#GetStr): function for exploding strings
* [gift](#gift): function to generate Gift
* [include](#include): function to include code from another file
* [proxy](#proxy): function for testing your proxy in server lumtest
* [proxy1](#proxy1): function for testing your proxy in server Google
* [rand](#rand): function native of PHP to randomize numbers
* [randomizador](#randomizador): function for randomize strings or keys in array
* [sleep](#sleep): function async/await for sleeping your application for some time
* [substr_count](#substr_count): function equivalent to substr_count in php

***

### BIN

```js
const { bin } = require("johngrimm-utils")

let chkbin = bin(554927)

console.log(chkbin)
/**
 * Return an Object:
 * Bank
 * Type
 * Brand
 * Nivel
 * Country
 */
```


### CURL

```js
const { curl } = require("johngrimm-utils")

const _ = async function(){

    let first_req = await curl({
        url: '', // url of site
        method: '', // method of request: GET, PUT, POST, OPTION
        headers: {
            '':''
        },
        proxy: '', // if use proxy, `http://${username}:${password}@${url}:${port}` or `http://${url}:${port}`
        body: '' // if use method POST
    })

    console.log(first_req) // print the result of the request on the console, only body

    let second_req = await curl({
        url: '', // url of site
        method: '', // method of request: GET, PUT, POST, OPTION
        headers: {
            '':''
        },
        proxy: '', // if use proxy, `http://${username}:${password}@${url}:${port}` or `http://${url}:${port}`
        body: '' // if use method POST or PUT
    }, true)

    console.log(second_req) // print the result of the request on the console, with body and headers req

}()
```

### DADOS

```js
const { dados } = require("johngrimm-utils")

let Person = dados()

console.log(Person)
/**
 * Return a Object with:
 * nome
 * idade
 * cpf
 * rg
 * data_nasc
 * sexo, signo
 * mae
 * pai
 * email
 * senha
 * cep
 * endereco
 * numero
 * bairro
 * cidade
 * estado
 * telefone_fixo
 * celular
 * altura
 * peso
 * tipo_sanguineo
 * cor
 */
```

### GerarCpf

```js
const { gerarCpf } = require("johngrimm-utils")
// generate cpf without punctuation
let cpf = gerarCpf()
// generate cpf with punctuation
let cpf_with_punctuation = gerarCpf(true)
// print on the console
console.log(cpf, cpf_with_punctuation)
```

### GetStr

```js
const { GetStr } = require("johngrimm-utils")

let string = 'hello world, JohnGrimm-utils'

let capture = GetStr(string, ', ', '-') // print 'JohnGrimm'

console.log(string, capture)
```

### Gift

```js
const { gift } = require("johngrimm-utils")

console.log(gift('xxxx-xxxx-xxxx-xxxx'))
```

### INCLUDE

code js: test.js
```js
const { gerarCpf } = require("johngrimm-utils")
// generate cpf without punctuation
let cpf = gerarCpf()
// generate cpf with punctuation
let cpf_with_punctuation = gerarCpf(true)

```

code js: index.js
```js
const { include } = require("johngrimm-utils")

include('test.js') // here's including all the code from the test.js file

console.log(cpf, cpf_with_punctuation)
```

### PROXY

```js
const { proxy } = require("johngrimm-utils")

const _ = async funtion(){

    let ip_proxy = 'http://127.0.0.1:80'

    let condition = await proxy(ip_proxy)

    if( condition == undefined ){
        console.log(`The Proxy: ${ip_proxy} is OFF`)
    } else if( condition.includes('ip') ){
        console.log(`The Proxy: ${ip_proxy} is ON`)
    } else {
        console.log(`The Proxy: ${ip_proxy} is OFF`)
    }

}()
```

### PROXY1

```js
const { proxy1 } = require("johngrimm-utils")

const _ = async funtion(){

    let ip_proxy = 'http://127.0.0.1:80'

    let condition = await proxy1(ip_proxy)

    if( condition == undefined ){
        console.log(`The Proxy: ${ip_proxy} is OFF`)
    } else if( condition.includes('google') ){
        console.log(`The Proxy: ${ip_proxy} is ON`)
    } else {
        console.log(`The Proxy: ${ip_proxy} is OFF`)
    }

}()
```

### RAND

```js
const { rand } = require("johngrimm-utils")

let number = rand(0, 999) // print number between 0 - 999

console.log(number)
```

### RANDOMIZADOR

```js
const { randomizador } = require("johngrimm-utils")

let keys = ['John', 'Grimm', 'Utils', 'Module']

let randomize = randomizador(keys) // print a random key from the array

console.log(randomize)
```

### SLEEP

```js
const { sleep } = require("johngrimm-utils")

const _ = async function() {
    console.log(1)
    await sleep(1000) // declared time in ms
    console.log(2)
}()
```

### SUBSTR_COUNT

```js
const { substr_count } = require("johngrimm-utils")

let string = 'hello world, JohnGrimm-utils'
let capture = substr_count(string, 'J')
console.log(string, capture) // print 1
```

## Author

👤 **JohnGrimm**

* Github: [@JohnGrimm](https://github.com/JohnGrimm)
* Telegram: [@JohnGrimm37](https://t.me/JohnGrimm37)
* Discord: JohnGrimm#6956

## Show your support

Give a ⭐️ if this project helped you!

## 📝 License

Copyright © 2020 [JohnGrimm](https://github.com/JohnGrimm).<br />
This project is [MIT](LICENSE) licensed.