Teste
2 funções do TermoLeads para teste.
// npm install termo_core --save-exact
import * as leads from "termo_core/leads";
// ou: import { leads } from "termo_core";| Função | Rota | O que faz |
|---|---|---|
buscar_versao_test | GET / | Versão do backend no ar |
verificar_saude_test | GET /test | Verifica se o backend está no ar |
buscar_versao_test
GET/ Pública
Versão do backend no ar
Pública, sem token. Devolve sucesso: true e a versão do backend publicada, no formato semver. Qualquer rota que não existe responde 404 com { sucesso: false, mensagem: "Rota não encontrada" }.
function buscar_versao_test(
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.VersaoDoBackend>import { buscar_versao_test } from "termo_core/leads";
const resposta = await buscar_versao_test();Argumentos
Nome
Tipo
Retorno: Promise<tipos.VersaoDoBackend> · Rust: Result<tipos::VersaoDoBackend, ErroAoChamarServico> · veja VersaoDoBackend.
verificar_saude_test
GET/test Pública
Verifica se o backend está no ar
Pública, sem token. Responde 200 com sucesso: true e a versão do backend no ar (semver) sempre que o servidor está de pé; não consulta o banco nem o TermoAuth.
function verificar_saude_test(
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.SaudeTestDoBackend>import { verificar_saude_test } from "termo_core/leads";
const resposta = await verificar_saude_test();Argumentos
Nome
Tipo
Retorno: Promise<tipos.SaudeTestDoBackend> · Rust: Result<tipos::SaudeTestDoBackend, ErroAoChamarServico> · veja SaudeTestDoBackend.
Tipos
Tipos usados pelas funções desta página. O nome é o mesmo nos dois pacotes.
SaudeTestDoBackend
import type { SaudeTestDoBackend } from "termo_core/leads";
export interface SaudeTestDoBackend {
/**
* Sempre `Backend no ar`
*/
mensagem: string;
/**
* Sempre `true` quando o servidor está no ar
*/
sucesso: boolean;
/**
* Versão do backend no ar (semver)
*/
versao: string;
}VersaoDoBackend
import type { VersaoDoBackend } from "termo_core/leads";
export interface VersaoDoBackend {
/**
* Sempre `true` quando o servidor está no ar
*/
sucesso: boolean;
/**
* Versão do backend no ar (semver)
*/
versao: string;
}