andremarquezz / fakerBankBR

FakerBankBR é uma biblioteca que permite a geração de dados falsos, porém realistas, de contas bancárias brasileiras.

FakerBankBR

FakerBankBR é uma biblioteca que permite a geração de dados falsos, porém realistas, de contas bancárias brasileiras. É ideal para testes e desenvolvimento de aplicações que requerem dados bancários fictícios.

📦Instalação

Para usar o FakerBankBR, você pode instalá-lo via npm:

npm install --save-dev fakerbankbr

🪄Uso

Async/Await

const { createFakeBankAccount } = require('fakerbankbr');

// Gerar uma única conta bancária
// Retorna uma Promise, portanto deve estar dentro de uma função assíncrona
async () => {
  const conta = await createFakeBankAccount();
  // Utilização
};

// Gerar múltiplas contas bancárias (de 1 a 10)
// Retorna uma Promise, portanto deve estar dentro de uma função assíncrona
async () => {
  const contas = await createFakeBankAccount(5);
  // Utilização
};

Then

const { createFakeBankAccount } = require('fakerbankbr');

// Gerar uma única conta bancária
createFakeBankAccount().then((conta) => {
  // Utilização
});

// Gerar múltiplas contas bancárias (de 1 a 10)
createFakeBankAccount(5).then((contas) => {
  // Utilização
});

Exemplo de Resposta

Quando é gerada uma única conta:

{
  "account_number": "252258",
  "verification_digit": "6",
  "agency": "4282",
  "bank": "Banco do Brasil"
}

Quando são geradas múltiplas contas:

[
  {
    "account_number": "09988239",
    "verification_digit": "3",
    "agency": "1091",
    "bank": "Santander"
  },
  {
    "account_number": "84156",
    "verification_digit": "1",
    "agency": "3010",
    "bank": "Itaú"
  }
]

API

createFakeBankAccount(quantity)

• quantity: (Opcional) Número de contas bancárias a serem geradas. O padrão é 1 e o máximo é 10.

Retorna uma promise que resolve com um objeto de conta bancária ou um array de objetos de conta bancária, dependendo do parâmetro quantity.