Documentation Index
Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
Use this file to discover all available pages before exploring further.
Realizando um commit
application.commit() é um método que permite commitar um arquivo na sua aplicação.
Using Buffer
Using Absolute Path
const { SquareCloudAPI } = require("@squarecloud/api");
const api = new SquareCloudAPI("Sua Chave de API");
const application = await api.applications.get("ID da Aplicação");
// Especifique o conteúdo e o nome do arquivo que deseja commitar
const fileContent = Buffer.from("Conteúdo do seu arquivo");
const fileName = "arquivo.txt";
// Realize a operação de commit
const sucesso = await application.commit(fileContent, fileName);
// Trate o resultado conforme necessário
if (sucesso) {
console.log(`Arquivo "${fileName}" commitado com sucesso.`);
} else {
console.error(`Falha ao commitar o arquivo "${fileName}".`);
}
const { SquareCloudAPI } = require("@squarecloud/api");
const api = new SquareCloudAPI("Sua Chave de API");
const application = await api.applications.get("ID da Aplicação");
// Especifique o conteúdo e o nome do arquivo que deseja commitar
const { join } = require("node:path");
const fileName = "arquivo.txt";
const filePath = join(__dirname, fileName);
// Opcionalmente, defina se a aplicação deve reiniciar após o commit
const deveReiniciar = true;
// Realize a operação de commit
const sucesso = await application.commit(filePath, fileName, deveReiniciar);
// Trate o resultado conforme necessário
if (sucesso) {
console.log(`Arquivo "${fileName}" commitado com sucesso.`);
} else {
console.error(`Falha ao commitar o arquivo "${fileName}".`);
}
Realizando um upload
application.create() é um método que permite fazer upload de uma aplicação para a Square Cloud.
const { SquareCloudAPI } = require("@squarecloud/api");
const api = new SquareCloudAPI("Sua Chave de API");
// Especifique o conteúdo e o nome do arquivo zip que deseja enviar
const { join } = require("node:path");
const fileName = "aplicacao.zip";
const filePath = join(__dirname, fileName);
// Realize a operação de upload
const sucesso = await api.applications.create(filePath);
// Trate o resultado conforme necessário
if (sucesso) {
console.log(`Aplicação enviada com sucesso.`, sucesso);
// Retorna as informações da aplicação enviada (id, tag, descrição, etc.)
} else {
console.error(`Falha ao enviar aplicação.`);
}
Lembre-se que para enviar uma aplicação você precisa de um arquivo zip que contenha (pelo menos) os seguintes arquivos::
- Arquivo principal: responsável por iniciar sua aplicação
- Arquivo de dependências: contém informações sobre quais dependências são necessárias
- Arquivo de configuração (squarecloud.app): um arquivo de configuração especificando o nome, descrição, nome do arquivo principal, versão, etc. Para saber mais sobre o arquivo de configuração, veja este guia.