Liking cljdoc? Tell your friends :D

brazilian-utils.boleto

Brazilian boleto (payment slip) validation and utilities.

Brazilian boleto (payment slip) validation and utilities.
raw docstring

brazilian-utils.boleto.core

Core public API for boleto validation and parsing.

This is the main entry point for boleto functionality. Provides validation, type checking, and data extraction for Brazilian payment slips (boletos).

Core public API for boleto validation and parsing.

This is the main entry point for boleto functionality. Provides validation,
type checking, and data extraction for Brazilian payment slips (boletos).
raw docstring

brazilian-utils.boleto.format

Formatting functions for boleto digitable lines.

Provides visual formatting for bank boletos (47 digits) by inserting dots and spaces at standard positions.

Formatting functions for boleto digitable lines.

Provides visual formatting for bank boletos (47 digits) by inserting
dots and spaces at standard positions.
raw docstring

brazilian-utils.boleto.internal

Internal helper functions for boleto validation and processing.

Pure functions for DV calculation, digit parsing, and data extraction.

Internal helper functions for boleto validation and processing.

Pure functions for DV calculation, digit parsing, and data extraction.
raw docstring

brazilian-utils.boleto.parser

Parsing and data extraction functions for boleto digitable lines.

Provides functions to convert between barcode and digitable line formats, and to extract structured information from boletos.

Parsing and data extraction functions for boleto digitable lines.

Provides functions to convert between barcode and digitable line formats,
and to extract structured information from boletos.
raw docstring

brazilian-utils.boleto.schemas

Malli schemas and input normalization for boleto processing.

Provides schemas for validating and normalizing digitable line inputs.

Malli schemas and input normalization for boleto processing.

Provides schemas for validating and normalizing digitable line inputs.
raw docstring

brazilian-utils.boleto.validation

Validation logic for Brazilian boleto (payment slip) digitable lines.

Supports two types of boletos:

  • Bancário (bank boleto): 47 digits, for general payments
  • Arrecadação (collection boleto): 48 digits, for taxes and utility bills
Validation logic for Brazilian boleto (payment slip) digitable lines.

Supports two types of boletos:
- Bancário (bank boleto): 47 digits, for general payments
- Arrecadação (collection boleto): 48 digits, for taxes and utility bills
raw docstring

brazilian-utils.capitalize

String capitalization utilities.

Functions for capitalizing strings with support for Portuguese prepositions, conjunctions, and custom word rules.

Examples: (capitalize "esponja de aço") ;; => "Esponja de Aço" (capitalize "josé ama maria" {:lower-case-words ["ama"]}) ;; => "José ama Maria"

String capitalization utilities.

Functions for capitalizing strings with support for Portuguese prepositions,
conjunctions, and custom word rules.

Examples:
  (capitalize "esponja de aço") ;; => "Esponja de Aço"
  (capitalize "josé ama maria" {:lower-case-words ["ama"]}) ;; => "José ama Maria"
raw docstring

brazilian-utils.capitalize.core

Capitalize strings with support for prepositions and acronyms.

Functions for capitalizing strings in a way that respects Brazilian Portuguese conventions, handling prepositions, acronyms, and custom word rules.

Examples: (capitalize "esponja de aço") ;; => "Esponja de Aço" (capitalize "josé ama maria" {:lower-case-words ["ama"]}) ;; => "José ama Maria"

Capitalize strings with support for prepositions and acronyms.

Functions for capitalizing strings in a way that respects Brazilian Portuguese
conventions, handling prepositions, acronyms, and custom word rules.

Examples:
  (capitalize "esponja de aço") ;; => "Esponja de Aço"
  (capitalize "josé ama maria" {:lower-case-words ["ama"]}) ;; => "José ama Maria"
raw docstring

brazilian-utils.cep.validation

Validation schemas for CEP (Brazilian postal code).

Uses malli to define and validate CEP-related data structures.

Validation schemas for CEP (Brazilian postal code).

Uses malli to define and validate CEP-related data structures.
raw docstring

brazilian-utils.cities.core

Utilities to work with Brazilian cities by state (UF).

Utilities to work with Brazilian cities by state (UF).
raw docstring

brazilian-utils.cities.validation

Validation validation for Brazilian cities.

Uses malli to define and validate city-related data structures.

Validation validation for Brazilian cities.

Uses malli to define and validate city-related data structures.
raw docstring

brazilian-utils.cnh

Public API for CNH (Carteira Nacional de Habilitação) utilities.

Public API for CNH (Carteira Nacional de Habilitação) utilities.
raw docstring

brazilian-utils.cnh.core

Core utilities for CNH (Carteira Nacional de Habilitação).

Core utilities for CNH (Carteira Nacional de Habilitação).
raw docstring

brazilian-utils.cnh.internal

Internal utilities for CNH (Carteira Nacional de Habilitação) validation.

Internal utilities for CNH (Carteira Nacional de Habilitação) validation.
raw docstring

brazilian-utils.cnh.validation

Validation schema for CNH (Carteira Nacional de Habilitação).

Validation schema for CNH (Carteira Nacional de Habilitação).
raw docstring

brazilian-utils.cnpj

CNPJ validation and manipulation utilities.

Functions for validating, formatting, and generating Brazilian CNPJ (Cadastro Nacional da Pessoa Jurídica). All functions handle both formatted (XX.XXX.XXX/XXXX-XX) and unformatted (XXXXXXXXXXXXXX) inputs. Supports both numeric and alfanumeric CNPJs.

Examples: (is-valid? "12.345.678/0001-95") ;; => true or false (is-valid-alfanumeric? "12ABC.D34.5EF/G001-95") ;; => true or false (format-cnpj "12345678000195") ;; => "12.345.678/0001-95" (remove-symbols "12.345.678/0001-95") ;; => "12345678000195" (generate) ;; => "34567890000121" (random valid CNPJ)

CNPJ validation and manipulation utilities.

Functions for validating, formatting, and generating Brazilian CNPJ (Cadastro Nacional da Pessoa Jurídica).
All functions handle both formatted (XX.XXX.XXX/XXXX-XX) and unformatted (XXXXXXXXXXXXXX) inputs.
Supports both numeric and alfanumeric CNPJs.

Examples:
  (is-valid? "12.345.678/0001-95") ;; => true or false
  (is-valid-alfanumeric? "12ABC.D34.5EF/G001-95") ;; => true or false
  (format-cnpj "12345678000195") ;; => "12.345.678/0001-95"
  (remove-symbols "12.345.678/0001-95") ;; => "12345678000195"
  (generate) ;; => "34567890000121" (random valid CNPJ)
raw docstring

brazilian-utils.cpf

CPF validation and manipulation utilities.

Functions for validating, formatting, and generating Brazilian CPF (Cadastro de Pessoas Físicas). All functions handle both formatted (XXX.XXX.XXX-XX) and unformatted (XXXXXXXXXXX) inputs.

Examples: (is-valid? "123.456.789-09") ;; => true or false (format-cpf "12345678909") ;; => "123.456.789-09" (remove-symbols "123.456.789-09") ;; => "12345678909" (generate) ;; => "34567890120" (random valid CPF) (generate :SP) ;; => "34567890121" (with state code)

CPF validation and manipulation utilities.

Functions for validating, formatting, and generating Brazilian CPF (Cadastro de Pessoas Físicas).
All functions handle both formatted (XXX.XXX.XXX-XX) and unformatted (XXXXXXXXXXX) inputs.

Examples:
  (is-valid? "123.456.789-09") ;; => true or false
  (format-cpf "12345678909") ;; => "123.456.789-09"
   (remove-symbols "123.456.789-09") ;; => "12345678909"
  (generate) ;; => "34567890120" (random valid CPF)
  (generate :SP) ;; => "34567890121" (with state code)
raw docstring

brazilian-utils.currency

Brazilian currency (BRL) formatting and parsing utilities.

Brazilian currency (BRL) formatting and parsing utilities.
raw docstring

brazilian-utils.currency.format

Formatting functions for Brazilian currency (BRL).

Formatting functions for Brazilian currency (BRL).
raw docstring

brazilian-utils.date.core

Utilities for working with Brazilian dates and holidays.

Provides functions to:

  • Retrieve national holidays
  • Check if a date is a holiday
  • Get holiday names
  • Work with Brazilian calendar information
Utilities for working with Brazilian dates and holidays.

Provides functions to:
  - Retrieve national holidays
  - Check if a date is a holiday
  - Get holiday names
  - Work with Brazilian calendar information
raw docstring

brazilian-utils.date.internal

Internal helper functions for date operations.

Internal helper functions for date operations.
raw docstring

brazilian-utils.helpers

Shared helper functions used across brazilian-utils modules.

Provides common utility functions for string manipulation and validation used by other modules in the library.

Functions:

  • only-numbers: Extract digits from strings
  • repeated-digits?: Check if string has all same digits
  • char->digit: Convert digit character to numeric value
  • http-get: Make HTTP GET requests
Shared helper functions used across brazilian-utils modules.

Provides common utility functions for string manipulation and validation
used by other modules in the library.

Functions:
  - only-numbers: Extract digits from strings
  - repeated-digits?: Check if string has all same digits
  - char->digit: Convert digit character to numeric value
  - http-get: Make HTTP GET requests
raw docstring

brazilian-utils.index

No vars found in this namespace.

brazilian-utils.inscricao-estadual

Brazilian state registration (Inscrição Estadual) validation utilities.

Functions:

  • is-valid?: Validates IE for a given state
  • remove-symbols: Removes formatting characters

Supported states: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MG, MT, MS, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO

Examples: (require '[brazilian-utils.inscricao-estadual :as ie]) (ie/is-valid? :SP "110042490114") ;; => true (ie/remove-symbols "11.004.249.0114") ;; => "110042490114"

Brazilian state registration (Inscrição Estadual) validation utilities.

Functions:
  - is-valid?: Validates IE for a given state
  - remove-symbols: Removes formatting characters

Supported states: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MG, MT, MS,
                 PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO

Examples:
  (require '[brazilian-utils.inscricao-estadual :as ie])
  (ie/is-valid? :SP "110042490114") ;; => true
  (ie/remove-symbols "11.004.249.0114") ;; => "110042490114"
raw docstring

brazilian-utils.inscricao-estadual.core

Core utilities for Brazilian state registration (Inscrição Estadual).

Core utilities for Brazilian state registration (Inscrição Estadual).
raw docstring

brazilian-utils.inscricao-estadual.internal

Internal validation logic for Brazilian state registration (IE). Coordinates validation by state using modular validators.

Internal validation logic for Brazilian state registration (IE).
Coordinates validation by state using modular validators.
raw docstring

brazilian-utils.inscricao-estadual.validation

Validation schema for Brazilian State Registration (Inscrição Estadual).

Validation schema for Brazilian State Registration (Inscrição Estadual).
raw docstring

brazilian-utils.inscricao-estadual.validators.ba

Bahia (BA) - 8 ou 9 dígitos, dois dígitos verificadores. Regra do módulo:

  • IE com 8 dígitos: verifica conforme primeiro dígito
  • IE com 9 dígitos: verifica conforme primeiro dígito (posição 1)
  • Se primeiro dígito ∈ {0,1,2,3,4,5,8} usa módulo 10; caso contrário usa módulo 11
Bahia (BA) - 8 ou 9 dígitos, dois dígitos verificadores.
Regra do módulo:
- IE com 8 dígitos: verifica conforme primeiro dígito
- IE com 9 dígitos: verifica conforme primeiro dígito (posição 1)
- Se primeiro dígito ∈ {0,1,2,3,4,5,8} usa módulo 10; caso contrário usa módulo 11
raw docstring

brazilian-utils.inscricao-estadual.validators.mg

Minas Gerais (MG) - 13 dígitos, dois dígitos verificadores. Regra conforme implementação do brazilian-utils/javascript.

Minas Gerais (MG) - 13 dígitos, dois dígitos verificadores.
Regra conforme implementação do brazilian-utils/javascript.
raw docstring

brazilian-utils.inscricao-estadual.validators.rj

Rio de Janeiro (RJ) - 8 dígitos

Rio de Janeiro (RJ) - 8 dígitos
raw docstring

brazilian-utils.inscricao-estadual.validators.rr

Roraima (RR) - 9 dígitos. Must start with '24'. Special algorithm: DV = (sum of digits * growing weights) % 9

Roraima (RR) - 9 dígitos. Must start with '24'.
Special algorithm: DV = (sum of digits * growing weights) % 9
raw docstring

brazilian-utils.inscricao-estadual.validators.sp

São Paulo (SP) - 12 dígitos Position 9: first DV (weights [1,3,4,5,6,7,8,10]) Position 12: second DV (weights start at 3, decrement, wrap from 1 to 10)

São Paulo (SP) - 12 dígitos
Position 9: first DV (weights [1,3,4,5,6,7,8,10])
Position 12: second DV (weights start at 3, decrement, wrap from 1 to 10)
raw docstring

brazilian-utils.license-plate

Brazilian license plate validation utilities.

Convenient namespace that reexports all license plate validation functions. Supports both traditional and Mercosul license plate formats.

Functions:

  • is-valid?: Validates any license plate
  • get-format: Returns format type (LLLNNNN or LLLNLNN)
  • convert-to-mercosul: Converts traditional to Mercosul format

Examples: (require '[brazilian-utils.license-plate :as plate]) (plate/is-valid? "ABC-1234") ;; true (plate/get-format "ABC1234") ;; "LLLNNNN" (plate/convert-to-mercosul "ABC1234") ;; "ABC1B34"

Brazilian license plate validation utilities.

Convenient namespace that reexports all license plate validation functions.
Supports both traditional and Mercosul license plate formats.

Functions:
  - is-valid?: Validates any license plate
  - get-format: Returns format type (LLLNNNN or LLLNLNN)
  - convert-to-mercosul: Converts traditional to Mercosul format

Examples:
  (require '[brazilian-utils.license-plate :as plate])
  (plate/is-valid? "ABC-1234") ;; true
  (plate/get-format "ABC1234") ;; "LLLNNNN"
  (plate/convert-to-mercosul "ABC1234") ;; "ABC1B34"
raw docstring

brazilian-utils.license-plate.core

Brazilian license plate validation and formatting utilities.

Supports both traditional (ABCD1234) and Mercosul (ABC1D23) formats. Public API:

  • is-valid?: validate Mercosul or traditional plates
  • get-format: detect format as "LLLNNNN" or "LLLNLNN"
  • convert-to-mercosul: convert traditional plates to Mercosul style
Brazilian license plate validation and formatting utilities.

Supports both traditional (ABCD1234) and Mercosul (ABC1D23) formats.
Public API:
  - is-valid?: validate Mercosul or traditional plates
  - get-format: detect format as "LLLNNNN" or "LLLNLNN"
  - convert-to-mercosul: convert traditional plates to Mercosul style
raw docstring

brazilian-utils.license-plate.validation

Validation schemas for Brazilian license plates.

Supports both traditional plates (3 letters + 4 digits) and Mercosul plates (3 letters + 1 digit + 1 letter + 2 digits).

Uses malli to define and validate license plate data structures.

Validation schemas for Brazilian license plates.

Supports both traditional plates (3 letters + 4 digits) and 
Mercosul plates (3 letters + 1 digit + 1 letter + 2 digits).

Uses malli to define and validate license plate data structures.
raw docstring

brazilian-utils.pis

Brazilian PIS (Programa de Integração Social) validation and utilities.

Brazilian PIS (Programa de Integração Social) validation and utilities.
raw docstring

brazilian-utils.processo-juridico

Brazilian Processo Jurídico (court case) validation and utilities.

Brazilian Processo Jurídico (court case) validation and utilities.
raw docstring

brazilian-utils.renavam

Public API for RENAVAM utilities.

Public API for RENAVAM utilities.
raw docstring

brazilian-utils.renavam.core

Core utilities for RENAVAM validation.

Core utilities for RENAVAM validation.
raw docstring

brazilian-utils.renavam.validation

Validation schema for RENAVAM.

Validation schema for RENAVAM.
raw docstring

brazilian-utils.states.validation

Validation schemas for Brazilian states (UF).

Uses malli to define and validate state-related data structures.

Validation schemas for Brazilian states (UF).

Uses malli to define and validate state-related data structures.
raw docstring

brazilian-utils.titulo-eleitoral

Public API for Título Eleitoral (Voter ID) utilities.

Public API for Título Eleitoral (Voter ID) utilities.
raw docstring

brazilian-utils.titulo-eleitoral.core

Core utilities for Título Eleitoral.

This module provides validation and generation utilities for Títulos Eleitorais. Validation checks mathematical correctness and structure, but does NOT verify if the ID exists in TSE's registry.

Core utilities for Título Eleitoral.

This module provides validation and generation utilities for
Títulos Eleitorais. Validation checks mathematical correctness and
structure, but does NOT verify if the ID exists in TSE's registry.
raw docstring

brazilian-utils.titulo-eleitoral.internal

Internal utilities for Título Eleitoral validation.

Internal utilities for Título Eleitoral validation.
raw docstring

brazilian-utils.titulo-eleitoral.validation

Validation schemas for Título Eleitoral.

Validation schemas for Título Eleitoral.
raw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close