jardelgoncalves

broleto

Uma biblioteca para validar, formatar e obter informações do boletos.

  "description": "Uma biblioteca para validar, formatar e obter informações do boletos.",

"author": "Jardel Gonçalves Ferreira <jardelgoncalves1996@gmail.com>",

    "test": "jest --config jest.config.json",

    "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",

    "@commitlint/config-conventional": "^8.3.4",

    "@rollup/plugin-commonjs": "^11.0.2",

    "@rollup/plugin-node-resolve": "^7.1.1",

    "@typescript-eslint/eslint-plugin": "^2.24.0",

    "@typescript-eslint/parser": "^2.24.0",

    "eslint-config-airbnb-base": "^14.1.0",

    "eslint-import-resolver-typescript": "^2.0.0",

    "rollup-plugin-peer-deps-external": "^2.2.2",

    "rollup-plugin-typescript2": "^0.26.0",

      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"

  Valide e/ou obtenha dados de boletos bancário ou arrecadação de forma fácil 💵

Uma biblioteca que suporta validação e obtenção de boletos bancários ou arrecadação seja pela linha digitável ou código de barras com ou sem formatação.

const boleto = new Boleto('34191091070000013555851122200002157810000115300');

Caso o boleto seja de arrecadação ou o banco não esteja mapeado na biblioteca será retornado uma string `Unknown`

### Obtendo o tipo de código/numeração do boleto

Essa função irá retornar se o boleto é `LINHA DIGITAVEL`, `CODIGO DE BARRAS` ou `INVALIDO`.

Essa função irá retornar se o boleto é `ARRECADACAO` ou `BANCO`.

Em caso de `ARRECADACAO` é retornado um subtipo que podem ser os seguintes valores:

`ARRECADACAO_PREFEITURA`, `CONVENIO_SANEAMENTO`, `CONVENIO_ENERGIA_ELETRICA_E_GAS`,

`CONVENIO_TELECOMUNICACOES`, `ARRECADACAO_ORGAOS_GOVERNAMENTAIS`, `OUTROS`,

`ARRECADACAO_TAXAS_DE_TRANSITO` ou `''` (string vazia)

### Obtendo a quantidade de dias que o boleto está vencido

Caso o boleto não esteja é retornado o valor `0`

Disponibilizamos também a possibilidade de calcular juros do boleto. O método pode receber até 4 parâmetros.

`boleto.interest(interestValue, expiredDays = false, percent = true, month = true)`

- `interestValue` - é um valor numérico que corresponde a porcentagem ou valor cobrado como juros.

- `expiredDays` - pode receber ou um valor **numerico** que se refere a quantidade de dias vencidos do boleto ou um valor **booleano** (false) caso queira que a quantidade de dias vencidos usado no cálculo do juros seja obtido de forma automática, por padrão esse valor é `false`.

- `percent` - é um valor booleano que por padrão é `true` refere-se ao tipo do valor informado. Em caso de true isso quer dizer que o valor informado para `interestValue` no calculo é em porcentagem. Caso informe false o `interestValue` passa a ser compreendido como valor em reais.

- `month` - Informa como o juros é calculado, se é ao mês ou ao dia. Por padrão o valor é `true`, ou seja, no calculo o juros cobrado será ao mês. Caso queria informar que o juros é calculado ao dia, informe `false` para este parâmetro.

Disponibilizamos também a possibilidade de calcular multa do boleto. O método pode receber até 2 parâmetros.

`boleto.fines(finesValue, percent = true)`

- `finesValue` - é um valor numérico que corresponde a porcentagem ou valor cobrado como multa.

- `percent` - é um valor booleano que por padrão é `true` refere-se ao tipo do valor informado. Em caso de `true` isso quer dizer que o valor informado para `finesValue` no calculo é em porcentagem. Caso informe `false` o `finesValue` passa a ser compreendido como valor em reais.

// output (nesse caso o boleto possui 17 reais de multa)

Existe um método que agrupa as demais informações sobre um boleto.

		{
		"name": "broleto",
		"version": "0.0.4",
		"version": "0.0.5",
		"description": "Uma biblioteca para validar, formatar e obter informações do boletos.",
		@@ -5,0 +5,0 @@ "main": "dist/index.js",

		<p align="center">
		<img src="logo.png" width="200">
		<img src="https://raw.githubusercontent.com/jardelgoncalves/broleto/master/logo.png" width="200">
		</p>
		@@ -22,2 +22,10 @@

		### Verificando se o boleto é válido
		```js
		boleto.valid();
		// output

		true
		```

		### Obtendo o banco emissor
		@@ -24,0 +32,0 @@ Caso o boleto seja de arrecadação ou o banco não esteja mapeado na biblioteca será retornado uma string `Unknown`

New alerts

Improved metrics

Worsened metrics