🏓Respostas

Aqui falaremos sobre tudo do que o modulo retorna.

Aqui iremos falar sobre praticamente tudo sobre oque o modulo retorna como códigos de resposta, efeitos, sucesso e outros.

Como o formato de resposta pode ser (Object)

Esses são os utilizados mas alguns pode não vir dependendo da ocasião

success: true,      // If successed or no..
errcode: 0,         // This is the response code! 11, 12, 21, 22 ...
effect: "Nenhum.",  // The effect message. EX: "Document Created."
document: {...},    // Document in every time is JSON
collection: "serv", // Collection name only.
message: "Done!"    // Message if successed is will be "Done!" (default)

Atenção

Se caso você precise de algum valor que a LDE retorne você precisara usar await. ou then() por culpa das <Promise>, e por causa disso aqui em Pegando respostas iremos falar sobre isso.

Pegando respostas

Para que nós consigamos garantir os retornos dos comandos precisaremos saber uma coisa. Quando o código encerrou o processo e vai retornar algum valor, se caso não seja esperado retornará uma <Promise>(Promessa), e acaba que não é possível receber os valores, Então será necessário utilizar um desses dois exemplos a baixo.

Exemplos:

Nesses dois exemplos o comando get será usado como exemplo:

Método then()

const datastorage = require("local-db-express"); // calling

datastorage.document.get("my_collection", "cool_document").then((result) => {
    console.log(result)
    //console.log(result.document)
});

Método async...

const datastorage = require("local-db-express"); // calling

async function someFunction() {
    const result = await datastorage.document.get("my_collection", "cool_document")
    console.log(result)
    //console.log(result.document)
};

someFunction();

Nota-se que qual quer outro comando funcionara nesse exemplo de then() e await.

Mensagens & Efeitos

Um tipo de retorno padrão em qualquer situação ela ira vir. Contando o motivo do erro ou do sucesso.

Mensagens

Já as mensagens, sempre retornaram oque esta acontecendo narrando praticamente tudo.

Exemplo

{
    success: false,
    errcode: 3,
    effect: "Nenhum.",
    message: "É necessário enviar junto o nome da coleção. STRING" // <--
};

Efeitos

Os efeitos quando ocorre um erro geralmente retornam "Nenhum." Se ocorreu um erro, quer dizer que nada aconteceu por algum motivo. Se não eles iram falar oque aconteceu.

Exemplo

{
    success: true,
    errcode: 0,
    effect: "Documento foi criado.", // <--
    document: {...},
    collection: "my_collection",
    message: "Done!"
};

Códigos de respostas

Esquema

Eles funcionam nesse esquema: "1 - prefixo" + "2 - sufixo" resultado de código é: 12

Prefixos

• 0 - Success;

• 1 - Something don't exists;

• 2 - Something already exists;

• 3 - Value invalid;

• 4 - Code abort;

Sufixos

• 11 - Collection don't exists/don't exists;

• 12 - Document don't exists/don't exists;

• 21 - Collection already exists/don't exists;

• 22 - Document already exists/don't exists;