Global

Members

(constant) commandCache :LRU

Cache de módulos com política LRU (Least Recently Used), mais eficiente que um Map simples.
Type:
  • LRU
Properties:
Name Type Description
max number Número máximo de itens no cache.
maxSize number Tamanho máximo do cache em bytes.
sizeCalculation function Função que calcula o tamanho de cada item em bytes.
ttl number Tempo de vida dos itens no cache (em milissegundos).
Source:

currentSort :Object

Objeto que armazena a coluna e a direção de ordenação atual.
Type:
  • Object
Properties:
Name Type Description
column string | null Nome da coluna atualmente sendo ordenada.
ascending boolean Se a ordenação é crescente.
Source:

envInfo :envInfo

Configuração de fábrica do comando.
Type:
Source:

isListView :boolean

Variável que controla o estado de exibição da lista de parceiros.
Type:
  • boolean
Source:

(constant) missing :Array.<string>

Lista de programas ausentes.
Type:
  • Array.<string>
Source:

(constant) partners :Array.<Object>

Lista de parceiros com informações detalhadas.
Type:
  • Array.<Object>
Source:

(constant) programDownloads :Object

URLs de download ou comandos de instalação para programas ausentes, organizados por plataforma.
Type:
  • Object
Source:

(constant) programExists :Object

Verifica a existência de programas essenciais.
Type:
  • Object
Source:

(constant) sqlDatabase :BSQLite

Cria uma nova instância da database SQLite
Type:
  • BSQLite
Source:

Methods

.onclick()

Alterna o menu de navegação em dispositivos móveis.
Source:

.onclick()

Exporte os dados dos parceiros para um arquivo JSON.
Source:

addMessageHandler(chatId, handler, timeout)

Adiciona um manipulador de mensagens com timeout.
Parameters:
Name Type Default Description
chatId string O ID do chat para o qual o coletor é adicionado.
handler function A função de aguardar mensagens.
timeout number 60000 O tempo em milissegundos após o qual o coletor será removido.
Source:

ambientDetails(envData) → {Object}

Retorna todos os detalhes do ambiente (`envData`).
Parameters:
Name Type Description
envData Object O objeto que contém as configurações e dados do ambiente.
Source:
Returns:
O objeto `envData`, que contém os detalhes do ambiente.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

ambientDetails() → {Object}

Retorna todos os detalhes do ambiente (`envInfo`).
Source:
Returns:
O objeto `envInfo`, que contém os detalhes do ambiente da execução.
Type
Object

(async) blurImage(imageBufferopt, blurLopt, brightLopt) → {Promise.<Buffer>}

Aplica um efeito de blur e ajusta o brilho em uma imagem.
Parameters:
Name Type Attributes Default Description
imageBuffer Buffer <optional>
 envInfo.functions.blur.arguments.imageBuffer.value O buffer da imagem.
blurL number <optional>
 envInfo.functions.blur.arguments.blurL.value O nível de blur a ser aplicado.
brightL number <optional>
 envInfo.functions.blur.arguments.brightL.value O nível de brilho a ser ajustado.
Source:
Returns:
O buffer da imagem com os efeitos aplicados.
Type
Promise.<Buffer>

(async) calculateIdealNctx() → {Promise.<number>}

Calcula o valor ideal de nCtx com base nas características do sistema.
Source:
Returns:
Retorna uma Promise que resolve para o valor ideal de nCtx.
Type
Promise.<number>

caseChecker(commandNameopt, onlyCommandopt, isCommandopt) → {string|boolean}

Função para fazer checagem de comandos sem prefix. Verifica se um comando específico foi encontrado, com opções para diferenciar entre comandos com ou sem prefixo.
Parameters:
Name Type Attributes Default Description
commandName string <optional>
 '' O nome do comando a ser verificado.
onlyCommand boolean <optional>
 false Define se a verificação deve considerar apenas comandos com prefixo (true) ou sem prefixo (false).
isCommand boolean <optional>
 false Defina essa opção como 'isCmd' e não mexa nela, pois ela é responsável pela validação, se desejar customizar mais o prefix, edite apenas o 'onlyCommand'.
Source:
Returns:
- Retorna o nome do comando encontrado (sem prefixo) se a verificação for bem-sucedida, ou `false` caso contrário.
Type
string | boolean

(async) caseDefault(killopt, envopt) → {Promise.<Object>}

Função que executa comandos com base no input recebido.
Parameters:
Name Type Attributes Default Description
kill boolean <optional>
 false Funções padrões do Baileys, como sendMessage.
env Object <optional>
 false Objeto contendo informações do ambiente, como chatId, user, etc.
Source:
Returns:
Retorna um objeto com os resultados da execução.
Type
Promise.<Object>

(async) checkGaming(chessg, kill, chatId, gameCreator, reply, nowPlayer, rivalPlayer) → {string|boolean}

Verifica o estado do jogo e atualiza o resultado final (vitória, empate, etc.).
Parameters:
Name Type Description
chessg Object Objeto da biblioteca de xadrez (chess.js).
kill Object Função para enviar mensagens no chat.
chatId string ID do chat onde o jogo está sendo jogado.
gameCreator string ID do criador do jogo.
reply Object Objeto de configuração de resposta para o envio de mensagens.
nowPlayer string Jogador atual.
rivalPlayer string Jogador adversário.
Source:
Returns:
- Retorna o resultado do jogo (como 'draw', 'checkmate', etc.) ou `false` caso o jogo ainda esteja em andamento.
Type
string | boolean

checker(kill, saveCreds, genSession, startOptions, indexlaunch, launchInstance) → {void}

Função que verifica se todas as tarefas de inicialização foram concluídas.
Parameters:
Name Type Description
kill Object Objeto principal que contém a sessão e métodos do WhatsApp.
saveCreds function Função para salvar as credenciais da sessão.
genSession function Função para gerar ou recarregar a sessão.
startOptions Object Opções de inicialização para a sessão.
indexlaunch number Índice de inicialização para controle de múltiplas sessões.
launchInstance Object Objeto para as configurações de inicialização.
Source:
Returns:
Type
void

(async) chessDogs(kill, env) → {Object}

Função principal do xadrez, gerencia os comandos e interações com o jogo.
Parameters:
Name Type Description
kill Object Conjunto de funções para enviar mensagens e gerenciar o WhatsApp.
env Object Objeto contendo as variáveis de ambiente e dados do comando.
Source:
Returns:
- Retorna o estado final do jogo e o resultado.
Type
Object

cleanInvalidIPs()

Remove IPs inválidos do registro
Source:

(async) clearHistory()

Limpa o histórico das mensagens feitas na IA.
Source:

controlSystem(systemName) → {Object|boolean}

Controlador principal do sistema
Parameters:
Name Type Default Description
systemName string Default Nome do sistema/comando
Source:
Returns:
Módulo carregado ou false
Type
Object | boolean

(async) controlSystemAsync(systemName, bypassCacheopt) → {Promise.<(Object|boolean)>}

Versão assíncrona com suporte a hot reload
Parameters:
Name Type Attributes Default Description
systemName string Default Nome do sistema/comando
bypassCache boolean <optional>
 false Ignora cache para hot reload
Source:
Returns:
Promise com o módulo ou false
Type
Promise.<(Object|boolean)>

createCard(partner, index) → {HTMLElement}

Cria um cartão de exibição para um parceiro.
Parameters:
Name Type Description
partner Object O objeto do parceiro.
index number Índice do parceiro na lista.
Source:
Returns:
- O elemento do cartão.
Type
HTMLElement

createList(chatIDsopt) → {Object}

Transforma o grupo num tipo de seletor por números.
Parameters:
Name Type Attributes Default Description
chatIDs Array <optional>
 envInfo.functions.list.arguments.chatIDs.value A lista de IDs de chat.
Source:
Returns:
Um objeto indexado com os valores dos chats.
Type
Object

createListRow(partner, index) → {HTMLElement}

Cria uma linha de lista para um parceiro.
Parameters:
Name Type Description
partner Object O objeto do parceiro.
index number Índice do parceiro na lista.
Source:
Returns:
- O elemento da linha da lista.
Type
HTMLElement

createListener(kill, saveCreds, genSession, startOptions, indexlaunch, launchInstance) → {void}

Cria um listener para processar eventos do WhatsApp.
Parameters:
Name Type Description
kill Object Objeto principal que contém a sessão e métodos do WhatsApp.
saveCreds function Função para salvar as credenciais da sessão.
genSession function Função para gerar ou recarregar a sessão.
startOptions Object Opções de inicialização para a sessão.
indexlaunch number Índice de inicialização para controle de múltiplas sessões.
launchInstance Object Objeto para as configurações de inicialização.
Source:
Returns:
Type
void

customCommand(fileopt, useropt, chatIdopt, customCodeopt) → {Object}

Executa um comando personalizado na base de dados.
Parameters:
Name Type Attributes Default Description
file string <optional>
 envInfo.functions.custom.arguments.file.value Nome do arquivo SQL.
user string <optional>
 envInfo.functions.custom.arguments.user.value Identificador do usuário.
chatId string <optional>
 envInfo.functions.custom.arguments.chatId.value Identificador do chat.
customCode string <optional>
 envInfo.functions.custom.arguments.customCode.value Código SQL personalizado.
Source:
Returns:
Retorna os resultados do comando ou um objeto padrão em caso de erro.
Type
Object

deepMerge(target, source) → {Object}

Esta função percorre todas as propriedades do objeto source e: 1. Se a propriedade é um objeto (não array) em ambos target e source, faz merge recursivo 2. Caso contrário, sobrescreve a propriedade no target com o valor do source Observação: Arrays e objetos especiais (como Date, RegExp) serão sobrescritos, não mesclados.
Parameters:
Name Type Description
target Object O objeto destino que receberá as propriedades mescladas.
source Object O objeto fonte de onde as propriedades serão copiadas.
Source:
Returns:
O objeto target modificado com as propriedades mescladas.
Type
Object
Example
const obj1 = { a: 1, b: { c: 2 } };
const obj2 = { b: { d: 3 }, e: 4 };
deepMerge(obj1, obj2);
// Resultado: { a: 1, b: { c: 2, d: 3 }, e: 4 }

deepMerge(target, source) → {Object}

Realiza um merge profundo (deep merge) entre duas objects, combinando recursivamente. \ PLACEHOLDER, USE ISSO NO LUGAR: Indexer('others').merge(obj, obj).value;
Parameters:
Name Type Description
target Object O objeto destino que receberá as propriedades mescladas.
source Object O objeto fonte de onde as propriedades serão copiadas.
Source:
Returns:
O objeto target modificado com as propriedades mescladas.
Type
Object

dialoguePicker(regionPickeropt, folderPickeropt, dialogPickeropt, randomizeopt, extractOnlyOneopt, objectReplaceropt) → {Array|string}

Função que seleciona o idioma e o diálogo a ser retornado. PARA RETRO-COMPATIBILIDADE APENAS, USE A FUNÇÃO DE SQL PARA NOVOS COMANDOS E FUNÇÕES!!!
Parameters:
Name Type Attributes Default Description
regionPicker string <optional>
 'pt' Idioma a ser selecionado.
folderPicker string <optional>
 'Default' Pasta de diálogos.
dialogPicker string <optional>
 'Default' Nome do diálogo a ser selecionado.
randomize boolean <optional>
 true Se os diálogos devem ser aleatorizados.
extractOnlyOne boolean <optional>
 true Se deve retornar apenas um diálogo.
objectReplacer Object <optional>
 {} Substituições de chaves nos diálogos.
Source:
Returns:
- Um ou todos os diálogos do idioma selecionado.
Type
Array | string

dialoguePicker(regionPickeropt, folderPickeropt, dialogPickeropt, randomOrderopt, singleTextopt, objectReplaceropt) → {Object}

Obtém diálogos com base em parâmetros específicos, como idioma, pasta, diálogo e substituições.
Parameters:
Name Type Attributes Default Description
regionPicker string <optional>
 envInfo.functions.languages.arguments.regionPicker.value Idioma a ser utilizado. Enviar 'G.A.L' nesse paramêtro retorna uma array de sigla dos idiomas.
folderPicker string <optional>
 envInfo.functions.languages.arguments.folderPicker.value Pasta onde o diálogo está localizado.
dialogPicker string | Error <optional>
 envInfo.functions.languages.arguments.dialogPicker.value Nome do diálogo ou erro a ser tratado.
randomOrder boolean <optional>
 envInfo.functions.languages.arguments.randomOrder.value Define se a ordem dos diálogos deve ser aleatória.
singleText boolean <optional>
 envInfo.functions.languages.arguments.singleText.value Define se deve retornar apenas um diálogo.
objectReplacer Object <optional>
 envInfo.functions.languages.arguments.objectReplacer.value Objeto para substituir variáveis no diálogo.
Source:
Returns:
Retorna o diálogo formatado, uma array de siglas de idiomas ou um objeto padrão em caso de erro.
Type
Object

echoError(errorInput, envData, place) → {Object}

Insere o erro na `envData`, define o código de erro e a mensagem, e faz o log do erro.
Parameters:
Name Type Description
errorInput Error | any O erro a ser inserido na `envData`.
envData Object O objeto que contém as configurações e dados do ambiente.
place string O caminho atual do arquivo.
Source:
Returns:
O objeto `envData.results`, que contém o status do sucesso ou falha.
Type
Object

envInfoGenerator(envData) → {Object}

Placeholder para geração via nodejs para aqueles que preferem fazer algo assim. Função que gera um objeto de configuração envInfo para um sistema. Aceita um objeto de configuração para sobrescrever os valores padrão.
Parameters:
Name Type Description
envData Object Objeto contendo os valores personalizados.
Source:
Returns:
O objeto envInfo com as propriedades de uma envInfo completa.
Type
Object
Example
const envData = {
  name: 'Ping',
  license: 'MIT',
  developer: 'Seu Nome',
};
const envInfo = envInfoGenerator(envData);
envInfo.name // 'Ping'
envInfo.license // 'MIT'

executeSQLCommand(sql, params) → {any}

Executa um comando SQL de forma síncrona
Parameters:
Name Type Description
sql string O comando SQL a ser executado
params Object Parâmetros para substituição no SQL
Source:
Returns:
- O resultado da execução do SQL
Type
any

executeSQLite(sqlfolder, typecode, user, chatId, keyup, limit, value) → {void}

Executa um comando SQLite3 com base nos parâmetros fornecidos.
Parameters:
Name Type Description
sqlfolder string Nome da pasta onde o arquivo SQL está localizado.
typecode string Nome do arquivo SQL (sem extensão).
user string Identificador do usuário.
chatId string Identificador do chat.
keyup string Chave para atualização.
limit string Limite para a consulta.
value string Valor a ser inserido ou atualizado.
Source:
Returns:
Type
void

filterValues(fileopt, useropt, chatIdopt, keyfiltopt, mathsymopt, valueopt) → {Object}

Filtra valores específicos de usuários ou grupos na base de dados com base em uma chave e operador matemático.
Parameters:
Name Type Attributes Default Description
file string <optional>
 envInfo.functions.finder.arguments.file.value Nome do arquivo SQL.
user string <optional>
 envInfo.functions.finder.arguments.user.value Identificador do usuário.
chatId string <optional>
 envInfo.functions.finder.arguments.chatId.value Identificador do chat.
keyfilt string <optional>
 envInfo.functions.finder.arguments.keysort.value Chave para filtragem.
mathsym string <optional>
 envInfo.functions.finder.arguments.mathsym.value Operador matemático para filtragem.
value string | number <optional>
 envInfo.functions.finder.arguments.value.value Valor para comparação.
Source:
Returns:
Retorna os valores filtrados ou um objeto padrão em caso de erro.
Type
Object

findProperty(myObjectopt, findKeyopt, typeKeyopt, ignoreKeysopt) → {*}

Função para filtrar a chave de um objeto.
Parameters:
Name Type Attributes Default Description
myObject Object <optional>
 envInfo.functions.findkey.arguments.myObject.value O objeto onde a chave será buscada.
findKey Array.<string> <optional>
 envInfo.functions.findkey.arguments.findKey.value As chaves a serem localizadas.
typeKey Array.<string> <optional>
 envInfo.functions.findkey.arguments.typeKey.value Os tipos de dados permitidos para os valores.
ignoreKeys Array.<string> <optional>
 envInfo.functions.ignoreKeys.arguments.typeKey.value As chaves a serem ignoradas.
Source:
Returns:
O valor da chave encontrada ou `false` se não encontrado.
Type
*

finishStartup(httpServer, httpsServer, typeLog) → {Array.<number>|boolean}

Finaliza o processo de inicialização do servidor, exibindo URLs de acesso e armazenando as portas utilizadas.
Parameters:
Name Type Description
httpServer object | string Instância do servidor HTTP ou string com informações.
httpsServer object Instância do servidor HTTPS.
typeLog string Tipo de log para controle de saída.
Source:
Returns:
Retorna array com portas ou false se parâmetros inválidos.
Type
Array.<number> | boolean

fixDatabase(paramsopt) → {Object}

Recria as tabelas da base de dados mantendo seus dados (útil para atualizações que exigem alterações na estrutura).
Parameters:
Name Type Attributes Default Description
params Object <optional>
 {} Parâmetros adicionais para a correção da base de dados.
Properties
Name Type Attributes Default Description
first string <optional>
 envInfo.functions.fixdb.arguments.param1.value Primeiro parâmetro.
second string <optional>
 envInfo.functions.fixdb.arguments.param2.value Segundo parâmetro.
third string <optional>
 envInfo.functions.fixdb.arguments.param3.value Terceiro parâmetro.
fourth string <optional>
 envInfo.functions.fixdb.arguments.param4.value Quarto parâmetro.
fifth string <optional>
 envInfo.functions.fixdb.arguments.param5.value Quinto parâmetro.
oldDb string <optional>
 envInfo.functions.fixdb.arguments.oldDb.value Nome da base de dados antiga.
dbNames Array.<string> <optional>
 envInfo.functions.fixdb.arguments.dbNames.value Nomes das bases de dados a serem recriadas.
Source:
Returns:
Retorna os resultados da correção ou um objeto padrão em caso de erro.
Type
Object

formatBase64(str) → {object}

Função robusta para verificar e processar strings Base64 com manipulação de prefixos e múltiplas conversões
Parameters:
Name Type Description
str string String a ser validada como Base64 (pode conter prefixo data URI)
Source:
Returns:
Objeto contendo detalhes de validação, conversões e metadados
Type
object

functionString(key, val) → {*}

Converte funções e expressões regulares para uma representação em string no JSON. Isso é útil para serialização de objetos que podem conter funções ou regex.
Parameters:
Name Type Description
key string A chave do objeto que está sendo serializado.
val * O valor associado à chave que está sendo verificado.
Source:
Returns:
Retorna 'Function' se for função ou regex, caso contrário retorna o valor original.
Type
*

(async) genSession(launchOpt, i, launchInstancer) → {Promise.<Object>}

Gera uma sessão para a Íris.
Parameters:
Name Type Description
launchOpt Object Opções de inicialização da sessão.
i number Índice da sessão.
launchInstancer Object Objeto e instância de inicialização para controle de processos.
Source:
Returns:
Retorna um objeto contendo a instância do socket (`kill`) e a função para salvar credenciais (`saveCreds`).
Type
Promise.<Object>

generateContent()

Gera o conteúdo da lista de parceiros e exibe conforme o modo (cartão ou lista).
Source:

generateList(data, lang, chatId) → {string}

Gera uma lista de funções ativadas e desativadas junto com detalhes adicionais.
Parameters:
Name Type Default Description
data Object – Os dados que contêm informações da função.
lang string pt – O código do idioma para traduções.
chatId string – A id do chat atualmente.
Source:
Returns:
– Uma string formatada com funções habilitadas e desabilitadas e detalhes adicionais.
Type
string

(async) generateResponse(prompt) → {Promise.<string>}

Gera uma resposta para o prompt fornecido.
Parameters:
Name Type Description
prompt string O prompt para o qual a resposta deve ser gerada.
Source:
Returns:
- Uma promise que resolve com a response, 'INIT_REQUIRED' ou 'ERROR'.
Type
Promise.<string>

(async) generateResponse(question) → {Promise.<string>}

Gera uma resposta para a pergunta fornecida.
Parameters:
Name Type Description
question string A pergunta para a qual a resposta deve ser gerada.
Source:
Returns:
- Uma promise que resolve com a mensagem da resposta.
Type
Promise.<string>

(async) generateSessions() → {Promise.<void>}

Inicia uma ou mais sessões da Íris.
Source:
Returns:
Type
Promise.<void>

(async) getBuffer(imageURLopt) → {Promise.<Buffer>}

Adquire o Buffer de uma URL.
Parameters:
Name Type Attributes Default Description
imageURL string <optional>
 envInfo.functions.buffer.arguments.imageURL.value A URL da imagem.
Source:
Returns:
O buffer da imagem.
Type
Promise.<Buffer>

getKeyword(selectLangopt, nameListopt, tableNameopt, randomWordopt, fullCommandopt) → {Object}

Obtém uma palavra ou dado de uma tabela específica na base de dados.
Parameters:
Name Type Attributes Default Description
selectLang string <optional>
 region Idioma a ser utilizado.
nameList string <optional>
 envInfo.functions.keywords.arguments.nameList.value Nome da lista de palavras.
tableName string <optional>
 envInfo.functions.keywords.arguments.tableName.value Nome da tabela na base de dados.
randomWord boolean <optional>
 envInfo.functions.keywords.arguments.randomWord.value Define se a palavra deve ser escolhida aleatoriamente.
fullCommand string <optional>
 envInfo.functions.keywords.arguments.fullCommand.value Comando SQL personalizado (opcional).
Source:
Returns:
Retorna a palavra ou dado obtido, com informações adicionais, ou um objeto padrão em caso de erro.
Type
Object

getPatent(levelopt, patentsopt) → {*}

Obtém uma patente com base no nível fornecido.
Parameters:
Name Type Attributes Default Description
level string | number <optional>
 envInfo.functions.patent.arguments.level.value O nível da patente.
patents Object <optional>
 envInfo.functions.patent.arguments.patents.value O objeto contendo as patentes disponíveis.
Source:
Returns:
A patente correspondente ao nível ou a patente padrão (`patents['0']`).
Type
*

getRelativePath(scriptDir) → {Object}

Obtém o caminho relativo entre o diretório de trabalho atual e o diretório de um script.
Parameters:
Name Type Description
scriptDir string O caminho absoluto onde o script está (geralmente `__dirname`).
Source:
Returns:
Um objeto com o nome da pasta e o local relativo.
Type
Object

getValues(fileopt, useropt, chatIdopt) → {Object}

Adquire um ou todos os valores de uma base de dados.
Parameters:
Name Type Attributes Default Description
file string <optional>
 envInfo.functions.get.arguments.file.value Nome do arquivo SQL.
user string <optional>
 envInfo.functions.get.arguments.chatId.value Identificador do usuário.
chatId string <optional>
 envInfo.functions.get.arguments.chatId.value Identificador do chat.
Source:
Returns:
Retorna os valores obtidos ou um objeto padrão em caso de erro.
Type
Object

handleConnectionError(error, res, clientIP)

Trata erros durante o processo de conexão
Parameters:
Name Type Description
error Error Objeto de erro
res Object Objeto de resposta HTTP
clientIP string IP do cliente
Source:

handleFailedAttempts(res, clientIP)

Gerencia respostas para tentativas falhas de conexão
Parameters:
Name Type Description
res Object Objeto de resposta HTTP
clientIP string IP do cliente
Source:

handleSystemError(error, contextopt)

Tratamento de erros avançado com suporte a analytics
Parameters:
Name Type Attributes Description
error Error Objeto de erro
context string <optional>
 Contexto adicional
Source:

handleUnmappedCommand(commandName) → {Array.<string>}

Lida com comandos não mapeados com cache local
Parameters:
Name Type Description
commandName string Nome do comando
Source:
Returns:
Nome da pasta do comando
Type
Array.<string>

(async) hasCUDA() → {Promise.<boolean>}

Verifica se a GPU possui suporte para CUDA.
Source:
Returns:
Retorna uma Promise que resolve para um booleano indicando se a CUDA está disponível.
Type
Promise.<boolean>

initSocketConnection()

Inicializa a conexão via socket.io
Source:

(async) initializeModel(modelNameopt, moreSettingsopt, isCleaningopt) → {Promise.<(Object|string)>}

Inicializa o modelo e a sessão de chat.
Parameters:
Name Type Attributes Default Description
modelName string <optional>
 'rocket-3b.Q4_0.gguf' Nome do modelo a ser carregado.
moreSettings Object <optional>
 {} Nome do modelo a ser carregado.
isCleaning boolean <optional>
 false Nome do modelo a ser carregado.
Source:
Returns:
- Uma promise que resolve ao carregar o model, chat ou 'ERROR'.
Type
Promise.<(Object|string)>

(async) initializeModel(modelNameopt, modelTypeopt) → {Promise.<Object>}

Inicializa o pipeline do modelo. https://huggingface.co/models?library=transformers.js
Parameters:
Name Type Attributes Default Description
modelName string <optional>
 'Xenova/blenderbot_small-90M' Nome do modelo a ser carregado.
modelType string <optional>
 'text2text-generation' Tipo do modelo a ser usado.
Source:
Returns:
- Uma promise que resolve ao carregar o pipeline do modelo.
Type
Promise.<Object>

irisPlaying(chessg, chatId, user) → {string}

Realiza a jogada automática da Iris, escolhendo um movimento válido.
Parameters:
Name Type Description
chessg Object Objeto da biblioteca de xadrez (chess.js).
chatId string ID do chat onde o jogo está sendo jogado.
user string ID do jogador atual.
Source:
Returns:
- Retorna o FEN (posição do tabuleiro em formato FEN) após a jogada.
Type
string

isValidDate(dateInput) → {Object}

Converte e valida uma data (string ou timestamp) em um objeto padronizado.
Parameters:
Name Type Description
dateInput string | number Data como string (dd/mm/yy) ou timestamp.
Source:
Returns:
- Resultado com status, timestamp e formatos de data.
Type
Object

loadCommandModule(commandPath) → {Object}

Carrega o módulo do comando com cache e circuit breaker
Parameters:
Name Type Description
commandPath string Caminho do módulo
Source:
Throws:
Se o carregamento falhar
Type
Error
Returns:
Módulo carregado
Type
Object

(async) loadCommandModuleAsync(commandPath) → {Promise.<Object>}

Carrega módulo de forma assíncrona com tratamento moderno
Parameters:
Name Type Description
commandPath string Caminho do módulo
Source:
Throws:
Se o carregamento falhar
Type
Error
Returns:
Promise com o módulo
Type
Promise.<Object>

loadConfigWithRetry(configPath) → {object}

Carrega arquivos de configuração com tratamento de erros e retentativas
Parameters:
Name Type Description
configPath string Caminho do arquivo de configuração
Source:
Throws:
Se o arquivo não puder ser carregado após retentativas
Type
Error
Returns:
Objeto JSON carregado
Type
object

locateFolder(foldername) → {string}

Localiza a pasta correta com base no nome fornecido.
Parameters:
Name Type Description
foldername string Nome da pasta a ser localizada.
Source:
Returns:
Nome da pasta encontrada ou 'NONE/EXIT' se não encontrada.
Type
string

locateObjectKey(obj, keys, types, ignores, depthopt, visitedopt) → {*}

Função base para localizar uma chave em um objeto.
Parameters:
Name Type Attributes Default Description
obj Object O objeto onde a chave será buscada.
keys Array.<string> As chaves a serem localizadas.
types Array.<string> Os tipos de dados permitidos para os valores.
ignores Array.<string> As chaves a serem ignoradas.
depth number <optional>
 0 A profundidade atual da busca.
visited Set <optional>
 new Set() Conjunto de objetos já visitados para evitar referências circulares.
Source:
Returns:
O valor da chave encontrada ou `false` se não encontrado.
Type
*

logDebugInfo(logFilePath, erroropt)

Coleta informações detalhadas do sistema e do ambiente para ajudar na depuração.
Parameters:
Name Type Attributes Default Description
logFilePath string Caminho do arquivo de log onde as informações serão gravadas.
error Error <optional>
 null Objeto de erro opcional para capturar detalhes do erro.
Source:

logPerformance(type, pathy, start)

Log de performance padronizado
Parameters:
Name Type Description
type string Tipo de carregamento
pathy string Caminho do módulo
start number Timestamp de início
Source:

minifyFile(filePath)

Minifica ou remove comentários de arquivos JS substituindo o arquivo original pela versão modificada.
Parameters:
Name Type Description
filePath string Caminho do arquivo
Source:

minifyFolder(folderPath)

Recursivamente processa todos os arquivos JS de uma pasta
Parameters:
Name Type Description
folderPath string Caminho da pasta
Source:

modelConfigs() → {Object}

Retorna o estado atual do modelo e da sessão de chat.
Source:
Returns:
- Objeto contendo o estado do modelo e da sessão de chat.
Type
Object

modelConfigs() → {Object}

Retorna se o pipeline está online.
Source:
Returns:
- Objeto contendo o estado do pipeline.
Type
Object

(async) myFunction(env)

Cria a função de comando, EDITE O NOME DELA AQUI
Parameters:
Name Type Description
env MyObject A object contendo as informações.
Source:

postResults(envData) → {Object}

Realiza funções de pós-finalização, incluindo a verificação e reset da `envData`.
Parameters:
Name Type Description
envData Object O objeto que contém as configurações e dados do ambiente.
Source:
Returns:
O resultado das operações.
Type
Object

(async) processMessages(messages, original) → {Promise.<Array>}

Função assíncrona que processa uma lista de mensagens, executando ações com base em dados extraídos de cada mensagem e enviando resultados para o WebSocket.
Parameters:
Name Type Description
messages Array Um array de mensagens a serem processadas. Cada mensagem será manipulada individualmente.
original Object A array com as mensagens originais a serem processadas.
Source:
Returns:
Um array de resultados de todas as execuções, resolvido após todas as mensagens terem sido processadas.
Type
Promise.<Array>
Example
const messages = [...]; // Array de mensagens a serem processadas
processMessages(messages).then(results => {
    console.log(results); // Exibe os resultados após o processamento
});

purgeValues(fileopt, useropt, chatIdopt, initKeyopt, finKeyopt) → {Object}

Remove valores específicos de um usuário ou grupo na base de dados.
Parameters:
Name Type Attributes Default Description
file string <optional>
 envInfo.functions.purge.arguments.file.value Nome do arquivo SQL.
user string <optional>
 envInfo.functions.purge.arguments.user.value Identificador do usuário.
chatId string <optional>
 envInfo.functions.purge.arguments.chatId.value Identificador do chat.
initKey string <optional>
 envInfo.functions.purge.arguments.initKey.value Chave inicial para remoção.
finKey string | boolean | Object <optional>
 envInfo.functions.purge.arguments.finKey.value Chave final para remoção.
Source:
Returns:
Retorna os valores atualizados ou um objeto padrão em caso de erro.
Type
Object

rankingValues(fileopt, chatIdopt, keysortopt, limitopt) → {Object}

Adquire o JSON de um ID específico, ordenando os valores com base em uma chave.
Parameters:
Name Type Attributes Default Description
file string <optional>
 envInfo.functions.finder.arguments.file.value Nome do arquivo SQL.
chatId string <optional>
 envInfo.functions.finder.arguments.chatId.value Identificador do chat.
keysort string <optional>
 envInfo.functions.finder.arguments.keysort.value Chave para ordenação.
limit string <optional>
 envInfo.functions.finder.arguments.limit.value Limite de resultados.
Source:
Returns:
Retorna os valores ordenados ou um objeto padrão em caso de erro.
Type
Object

(async) readingMessages(msg, original) → {Promise.<void>}

Função assíncrona que processa e executa ações com base nas mensagens recebidas.
Parameters:
Name Type Description
msg Object A mensagem que está sendo processada.
original Object A mensagem original que está sendo processada.
Source:
Returns:
Uma promise que é resolvida após o processamento da mensagem.
Type
Promise.<void>

removeCommentsAndEmptyLines(sql) → {string}

Remove comentários e linhas vazias do código SQL
Parameters:
Name Type Description
sql string A string SQL original
Source:
Returns:
- A string SQL sem comentários e linhas vazias
Type
string

removeValues(fileopt, useropt, chatIdopt) → {Object}

Remove um usuário ou grupo da base de dados.
Parameters:
Name Type Attributes Default Description
file string <optional>
 envInfo.functions.remove.arguments.file.value Nome do arquivo SQL.
user string <optional>
 envInfo.functions.remove.arguments.user.value Identificador do usuário.
chatId string <optional>
 envInfo.functions.remove.arguments.chatId.value Identificador do chat.
Source:
Returns:
Retorna os valores atualizados ou um objeto padrão em caso de erro.
Type
Object

replaceInAll(myObjectopt, findTextopt, newTextopt) → {Object}

Substitui texto em todas as ocorrências dentro de um objeto.
Parameters:
Name Type Attributes Default Description
myObject Object <optional>
 envInfo.functions.replaceInAll.arguments.myObject.value O objeto onde o texto será substituído.
findText string <optional>
 envInfo.functions.replaceInAll.arguments.findText.value O texto a ser substituído.
newText string <optional>
 envInfo.functions.replaceInAll.arguments.newText.value O novo texto.
Source:
Returns:
O objeto com o texto substituído.
Type
Object

replaceSystem(obj, match, key) → {string}

Função que corrige o replace de variáveis em um objeto.
Parameters:
Name Type Description
obj Object O objeto onde a substituição será realizada.
match string O padrão de correspondência para substituição.
key string A chave para localizar o valor no objeto.
Source:
Returns:
O valor substituído ou '?' se não encontrado.
Type
string

replaceText(obj, ftext, ntext) → {Object}

Substitui texto em um objeto.
Parameters:
Name Type Description
obj Object O objeto onde o texto será substituído.
ftext string O texto a ser substituído.
ntext string O novo texto.
Source:
Returns:
O objeto com o texto substituído.
Type
Object

resetAmbient(changeKeyopt, jsonData, moreData, dirfolder) → {Object}

Função para resetar/atualizar configurações de ambiente com base em um arquivo JSON ou objeto. Permite a edição completa das configurações e inclui tratamento de erros robusto.
Parameters:
Name Type Attributes Default Description
changeKey Object <optional>
 {} Objeto contendo as chaves e valores a serem atualizados. Estrutura deve ser similar a da `envData` em `envInfoGenerator`. Mas deve conter as seguintes chaves essenciais: - `name`: Nome do ambiente/projeto (string) - `parameters`: Objeto com parâmetros de configuração - `functions`: Objeto com funções do ambiente - `exports`: Objeto com exportações necessárias
jsonData Object Objeto com as configs originais exportadas.
moreData Object Mais uma object para merge, útil em função circular.
dirfolder string Local de onde o sistema está executando a função.
Source:
Throws:
  • Se os parâmetros não forem do tipo esperado
    Type
    TypeError
  • Se houver falha ao ler/processar o arquivo de configuração
    Type
    Error
Returns:
Retorna um objeto contendo: - Todas as configurações atualizadas - success: boolean indicando sucesso/fracasso - error: null ou objeto de erro (se ocorrer)
Type
Object

resolveCommandPath(commandFolder) → {string}

Resolve o caminho completo para o comando com verificações
Parameters:
Name Type Description
commandFolder Array.<string> Nome da pasta do comando
Source:
Throws:
Se o caminho for inválido
Type
Error
Returns:
Caminho resolvido
Type
string

runTasks(kill, saveCreds, genSession, startOptions, useIndex, launchInstance) → {void}

Função de pós-inicialização que executa tarefas essenciais.
Parameters:
Name Type Description
kill Object Objeto principal que contém a sessão e métodos do WhatsApp.
saveCreds function Função para salvar as credenciais da sessão.
genSession function Função para gerar ou recarregar a sessão.
startOptions Object Opções de inicialização para a sessão.
useIndex number Índice de inicialização para controle de múltiplas sessões.
launchInstance Object Objeto para as configurações de inicialização.
Source:
Returns:
Type
void

safePathJoin(base, …paths) → {string}

Junção segura de caminhos para prevenir directory traversal
Parameters:
Name Type Attributes Description
base string Caminho base
paths string <repeatable>
 Partes do caminho
Source:
Throws:
Se tentativa de directory traversal for detectada
Type
Error
Returns:
Caminho seguro
Type
string

(async) sleep(milisecondsopt) → {Promise.<number>}

Faz a função esperar "x" tempo antes de avançar.
Parameters:
Name Type Attributes Default Description
miliseconds number <optional>
 envInfo.functions.sleep.arguments.miliseconds.value O tempo de espera em milissegundos.
Source:
Returns:
O tempo de espera em milissegundos.
Type
Promise.<number>

sortByColumn(column, ascending)

Ordena a lista de parceiros pela coluna especificada.
Parameters:
Name Type Description
column string A coluna a ser ordenada.
ascending boolean Se a ordenação é crescente.
Source:

toggleDescription(index, isListopt)

Alterna entre exibir a descrição completa ou resumida de um parceiro.
Parameters:
Name Type Attributes Default Description
index number Índice do parceiro na lista.
isList boolean <optional>
 false Se a exibição é no modo lista.
Source:

toggleListView()

Alterna entre o modo de exibição de lista e cartão.
Source:

undoValues(fileopt, useropt, chatIdopt, arrayundoopt) → {Object}

Reseta um ou mais valores na base de dados.
Parameters:
Name Type Attributes Default Description
file string <optional>
 envInfo.functions.purge.arguments.file.value Nome do arquivo SQL.
user string <optional>
 envInfo.functions.purge.arguments.user.value Identificador do usuário.
chatId string <optional>
 envInfo.functions.purge.arguments.chatId.value Identificador do chat.
arrayundo Array.<string> <optional>
 envInfo.functions.purge.arguments.keyundo.value Array de chaves a serem resetadas.
Source:
Returns:
Retorna os valores resetados ou um objeto padrão em caso de erro.
Type
Object

updateSortIcons(column, ascending)

Atualiza os ícones de ordenação de acordo com a coluna e a direção.
Parameters:
Name Type Description
column string A coluna que está sendo ordenada.
ascending boolean Se a ordenação é crescente.
Source:
Atualiza o arquivo symlinks.json com novos comandos de forma atômica
Parameters:
Name Type Description
commandName string Nome do novo comando
Source:
Throws:
Se a escrita falhar
Type
Error

updateValues(fileopt, useropt, chatIdopt, keyupopt, valueopt) → {Object}

Atualiza um valor específico na base de dados.
Parameters:
Name Type Attributes Default Description
file string <optional>
 envInfo.functions.update.arguments.file.value Nome do arquivo SQL.
user string <optional>
 envInfo.functions.update.arguments.user.value Identificador do usuário.
chatId string <optional>
 envInfo.functions.update.arguments.chatId.value Identificador do chat.
keyup string <optional>
 envInfo.functions.update.arguments.keyup.value Chave para atualização.
value string | Object <optional>
 envInfo.functions.update.arguments.value.value Valor a ser atualizado.
Source:
Returns:
Retorna os valores atualizados ou um objeto padrão em caso de erro.
Type
Object

(async) urlExists(urlopt) → {Promise.<boolean>}

Verifica se uma URL existe.
Parameters:
Name Type Attributes Default Description
url string <optional>
 envInfo.functions.urlexist.arguments.url.value A URL a ser verificada.
Source:
Returns:
`true` se a URL existe, `false` caso contrário.
Type
Promise.<boolean>

urlGo(index)

Redireciona para a URL de um parceiro.
Parameters:
Name Type Description
index number Índice do parceiro na lista.
Source:

validateCommandName(commandName) → {string}

Valida e sanitiza nomes de comandos para prevenir injeção
Parameters:
Name Type Description
commandName string Nome do comando a ser validado
Source:
Returns:
Nome sanitizado
Type
string

validateJSON(stringJSONopt) → {string|boolean}

Valida e corrige um JSON.
Parameters:
Name Type Attributes Default Description
stringJSON string | Object <optional>
 envInfo.functions.fixer.parameters.stringJSON.value JSON a ser validado.
Source:
Returns:
Retorna o JSON válido como string ou `false` em caso de erro.
Type
string | boolean

Type Definitions

Argument

Detalhes de um argumento da função.
Type:
  • Object
Properties:
Name Type Description
description string A descrição do argumento.
type string O tipo do argumento.
value * O valor padrão do argumento.
Source:

ConfigSetting

Configuração de uma função.
Type:
  • Object
Properties:
Name Type Description
description string A descrição da configuração.
type string O tipo da configuração.
value * O valor padrão da configuração.
Source:

FunctionDetails

Detalhes de uma função.
Type:
  • Object
Properties:
Name Type Description
arguments Object.<string, Argument> Os argumentos da função.
description string A descrição da função.
type string O tipo de retorno da função.
value * O valor padrão da função.
Source:

LevelSettings

Type:
  • Object
Properties:
Name Type Description
card Object Determina se Íris deve enviar cartões de nível sempre que alguém atingir um novo nível.
Properties
Name Type Description
value boolean O valor booleano para ativar ou desativar os cartões de nível.
materials Object A base de materiais obtidos por nível, usados para calcular o valor ótimo a fornecer.
Properties
Name Type Description
multiply number O multiplicador para calcular a quantidade de materiais por nível.
attenuation number A atenuação aplicada aos materiais por nível.
wins Object A quantidade de cada tipo de material ganho por vitória.
Properties
Name Type Description
coin number Quantidade de moedas ganhas por vitória.
diamond number Quantidade de diamantes ganhos por vitória.
rubi number Quantidade de rubis ganhos por vitória.
gold number Quantidade de ouro ganho por vitória.
iron number Quantidade de ferro ganho por vitória.
stone number Quantidade de pedra ganha por vitória.
wood number Quantidade de madeira ganha por vitória.
messageXP Object A quantidade de XP obtida por mensagem, excluindo mensagens desativadas, como reações.
Properties
Name Type Description
value number A quantidade de XP obtida por mensagem.
base Object A XP base para subir de nível, aplicada para calcular a XP correta por nível de usuário.
Properties
Name Type Description
value number A quantidade base de XP para subir de nível.
multiplier Object O multiplicador usado para calcular os requisitos para alcançar o próximo nível.
Properties
Name Type Description
value number O valor do multiplicador.
patentes Object Os nomes dos níveis em diferentes idiomas.
Properties
Name Type Description
pt Object.<string, string> Níveis em português.
jp Object.<string, string> Níveis em japonês.
en Object.<string, string> Níveis em inglês.
fr Object.<string, string> Níveis em francês.
es Object.<string, string> Níveis em espanhol.
id Object.<string, string> Níveis em indonésio.
ms Object.<string, string> Níveis em malaio.
hi Object.<string, string> Níveis em hindi.
de Object.<string, string> Níveis em alemão.
it Object.<string, string> Níveis em italiano.
ru Object.<string, string> Níveis em russo.
lat Object.<string, string> Níveis em latim.
Source:

MyObject

Um objeto com uma propriedade "value" que é do tipo {SpecificInfo}.
Type:
  • Object
Properties:
Name Type Description
value SpecificInfo Object com todos os dados.
Source:

Parameter

Parâmetro adicional do comando.
Type:
  • Object
Properties:
Name Type Description
description string A descrição do parâmetro.
type string O tipo do parâmetro.
value * O valor padrão do parâmetro.
Source:

Result

Resultado final da função.
Type:
  • Object
Properties:
Name Type Description
description string A descrição do resultado.
success boolean Indica se a função foi um sucesso.
type string O tipo do resultado.
value * O valor retornado pela função.
Source:

SpecificInfo

Object com todos os dados da mensagem e demais funções.
Type:
  • Object
Properties:
Name Type Description
actualMoment number O momento atual em milissegundos.
readDate string A data de leitura da mensagem, em segundos.
levelSettings LevelSettings As configurações de nível.
allCommands Array.<string> Todos os comandos disponíveis.
quoteThis Object A mensagem a ser citada.
Properties
Name Type Description
message Object A mensagem citada.
backupMessage Object Backup da mensagem original.
timestamp number O timestamp da mensagem.
pingTime string O tempo de ping avançado.
procTime number O tempo de ping.
editedMessageObj Object O objeto da mensagem editada.
editedMessage boolean Indica se a mensagem foi editada.
messageKey string A chave da mensagem.
isViewOnce boolean Indica se a mensagem é do tipo ViewOnce.
basemessage Object A mensagem base.
encryptMedia Object A mídia criptografada.
quotedMsg Object A mensagem citada.
isQuotedMsg boolean Indica se a mensagem é citada.
quotedMsgObj Object O objeto da mensagem citada.
isMedia boolean Indica se a mensagem é uma mídia.
decryptFormats Array.<string> Os formatos de mídia para descriptografia.
type string O tipo de mensagem.
typeFormatted string O tipo de mensagem formatado.
dateOfDay number A hora do dia.
time string O tempo da mensagem.
debugExec number O tempo de execução de debug.
sender string O remetente da mensagem.
chat Object O chat da mensagem.
originalName string O nome original do grupo.
name string O nome do grupo.
user string O número do remetente.
userFormated string O número do remetente formatado.
originalPushname string O pushname original.
pushname string O pushname formatado.
chatId string A ID do chat.
isGroup boolean Indica se é um grupo.
isGroupMsg boolean Indica se é uma mensagem de grupo.
id string A ID da mensagem.
serial string A cópia da ID da mensagem.
mimetype string O tipo de mídia da mensagem.
isVideo boolean Indica se a mensagem é um vídeo.
isImage boolean Indica se a mensagem é uma imagem.
canSticker boolean Indica se é possível fazer um sticker da mídia.
personal Object Os dados pessoais do remetente.
region string A região do idioma.
functions Object As funções do grupo.
Leveling Object Os dados de leveling do usuário.
Bank Object Os dados bancários do usuário.
prefixes Array.<string> Os prefixos disponíveis.
prefix string O prefixo usado na mensagem.
body string O conteúdo da mensagem.
urlData Array.<Object> Os dados das URLs encontradas na mensagem.
isInvite boolean Indica se a mensagem é um convite.
arguments Array.<string> Os argumentos da mensagem.
args Array.<string> Os argumentos sem o comando.
arg string Os argumentos em uma única string.
argl Array.<string> Os argumentos em lowercase.
arks string Os argumentos em lowercase em uma única string.
argc Array.<string> Os argumentos em uppercase.
arqc string Os argumentos em uppercase em uma única string.
emojis Array.<string> Os emojis encontrados na mensagem.
isCmd boolean Indica se a mensagem é um comando.
decryptedMedia string A mídia descriptografada.
command string O comando da mensagem.
commander string O responsável pelo comando.
mentionFinder Object O objeto de busca por menções.
mentionedJidList Array.<string> A lista de IDs mencionados.
mentionedJidListFormated Array.<string> A lista de IDs mencionados formatados.
groupMembersId Array.<string> A lista de IDs dos membros do grupo.
groupMembersIdFormated Array.<string> A lista de IDs dos membros do grupo formatados.
groupAdmins Array.<string> A lista de IDs dos administradores do grupo.
groupAdminsFormated Array.<string> A lista de IDs dos admins do grupo formatados.
isGroupAdmins boolean Indica se o remetente é um administrador do grupo.
isBotGroupAdmins boolean Indica se a Íris é um administrador do grupo.
groupCreator Object O criador do grupo.
isGroupCreator boolean Indica se o remetente é o criador do grupo.
isOwner boolean Indica se o remetente é o dono do bot.
isBot boolean Indica se a mensagem foi enviada pela Íris.
userPlatform string A plataforma do usuário.
blockNumber Array.<string> A lista de números bloqueados.
isBlocked boolean Indica se o remetente está bloqueado.
stickerConfig object As configurações do sticker.
isVIP boolean Indica se o remetente é VIP.
isModerator boolean Indica se o remetente é moderador.
isAllowed boolean Indica se o remetente tem permissão para executar o comando.
suggestCMD string Sugestão de comando.
side number Número aleatório entre 1 e 2.
lvpc number Número aleatório entre 1 e 100.
typeChat string Tipo de chat ('groups' ou 'private').
typeName string Nome do remetente (grupo ou usuário).
typeId string ID do remetente (grupo ou usuário).
randomMember string Membro aleatório do grupo.
upperCommand string Comando com a primeira letra em maiúscula.
alias Array.<string> Alias dos comandos.
functions object Funções do grupo.
leveling object Dados de level do usuário.
bank object Dados bancários do usuário.
oldbody string Corpo antigo da mensagem.
content string Conteúdo da mensagem.
caption string Legenda da mensagem.
comment string Comentário da mensagem.
filename string Nome do arquivo da mensagem.
matchedText string Texto correspondido na mensagem.
text string Texto da mensagem.
descriptionT string Descrição da mensagem.
titleT string Título da mensagem.
pollName string Nome da enquete.
pollOptions Array.<string> Opções da enquete.
recMessage string Mensagem recebida.
isSticker boolean Indica se a mensagem é um sticker.
isQuotedSticker boolean Indica se a mensagem possui um sticker citado.
isAnimated boolean Indica se o sticker é animado.
isQuotedAnimated boolean Indica se o sticker citado é animado.
stickerMetadata object Metadados do sticker.
allPatents Array.<string> Todas as patentes disponíveis.
patente string A patente do usuário.
requiredXP number O XP necessário para o próximo nível.
winTaxes object Os ganhos do usuário ao subir de nível.
leveling object Dados de level do usuário atualizados.
profilePics Array.<string> A foto de perfil do usuário.
Source:

envInfo

Estrutura de dados que descreve as configurações padrões de um comando, módulo ou função criados no Projeto Íris.
Type:
  • Object
Properties:
Name Type Description
name string O nome do comando, módulo ou função.
description string A descrição do comando, módulo ou função.
usage Object Detalhes sobre como usar o comando, módulo ou função.
Properties
Name Type Description
general string Uso geral do comando, módulo ou função.
examples Array.<string> Exemplos de uso do comando, módulo ou função.
license string A licença associada ao comando, módulo ou função.
helps Array.<string> Dicas adicionais sobre o comando, módulo ou função.
exports Object.<string, string> As funções exportadas pelo comando, módulo ou função.
developer string O desenvolvedor responsável pelo comando, módulo ou função.
files Object.<string, string> Os arquivos relacionados ao comando, módulo ou função.
modules Object.<string, string> Os módulos utilizados pelo comando, módulo ou função.
functions Object.<string, FunctionDetails> Os detalhes das funções do comando, módulo ou função.
settings Object.<string, ConfigSetting> As configurações do comando, módulo ou função.
parameters Object.<string, Parameter> Os parâmetros adicionais do comando, módulo ou função.
results Result O resultado final da função.
Source: