Commit und Upload

Eine neue Anwendung hochladen

api.applications.create(file) lädt eine Zip-Datei hoch und erstellt eine brandneue Anwendung. Das Argument file ist entweder ein lokaler Dateipfad oder ein Buffer.

import { SquareCloudAPI } from "@squarecloud/api";
import { join } from "node:path";

const api = new SquareCloudAPI(process.env.SQUARE_API_KEY!);

const result = await api.applications.create(join(__dirname, "my-app.zip"));

console.log(result.id);              // newly created application ID
console.log(result.name);            // display name
console.log(result.ram);             // allocated RAM in MB
console.log(result.cpu);             // allocated CPU shares
console.log(result.language);        // { name: "javascript", version: "22" }
console.log(result.description);     // string, only when set in squarecloud.config
console.log(result.subdomain);       // string, only when set in squarecloud.config

Mögliche Fehler sind UPLOAD_FAILED (Upload konnte nicht verarbeitet werden), STORAGE_UPLOAD_FAILED (Storage-Backend hat die Datei abgelehnt), INSUFFICIENT_MEMORY (Plan verfügt nicht über genug freies RAM) und FILE_TOO_LARGE (413, Zip überschreitet das Größenlimit). Die Zip-Datei muss mindestens enthalten:

Hauptdatei — Einstiegspunkt Ihrer Anwendung
Abhängigkeitsdatei — package.json, requirements.txt, usw.
squarecloud.app — Konfigurationsdatei mit Name, Beschreibung, Hauptdatei, Version usw. Siehe den Leitfaden zur Konfigurationsdatei

Dateien in eine bestehende Anwendung committen

app.commit(file, fileName?) lädt Dateien in eine bereits bereitgestellte Anwendung hoch. Übergeben Sie eine Zip-Datei, um mehrere Dateien auf einmal zu ersetzen, oder eine einzelne Datei, um nur diese eine zu aktualisieren.

Parameter	Typ	Beschreibung
`file`	`string \| Buffer`	Lokaler Dateipfad oder `Buffer`-Inhalt
`fileName`	`string?`	An den Upload angehängter Name. `.zip` wird auf dem Server extrahiert; jede andere Erweiterung wird als einzelne Datei geschrieben.

Intern akzeptiert die API einen Query-Parameter path, um zu steuern, wohin der Commit geschrieben wird; das SDK sendet ihn für Sie.

Eine einzelne Datei committen (Buffer)
Eine Zip-Datei von der Festplatte committen
Eine Datei per Pfad committen

const content = Buffer.from("console.log('hello')\n");
await app.commit(content, "index.js");

import { readFile } from "node:fs/promises";

const zip = await readFile("./dist.zip");
await app.commit(zip, "dist.zip");

import { join } from "node:path";

const filePath = join(__dirname, "index.js");
await app.commit(filePath, "index.js");

In v3 akzeptierte commit() ein drittes Argument restart. In v4 wurde der dritte Parameter entfernt — verwenden Sie app.restart() nach dem Commit, wenn Sie einen Neustart benötigen.

await app.commit(zip, "dist.zip");
await app.restart();

Mögliche Fehler sind UPLOAD_FAILED, STORAGE_UPLOAD_FAILED, INSUFFICIENT_MEMORY, FILE_TOO_LARGE (413), UPLOAD_ABORTED (der Client hat den Upload abgebrochen) und COMMIT_FAILED.

Dienste

Runtimes

Plattform

Fehlerbehebung

CLI

SDKs

Changelog

Eine neue Anwendung hochladen

Dateien in eine bestehende Anwendung committen

​Eine neue Anwendung hochladen

​Dateien in eine bestehende Anwendung committen

Eine neue Anwendung hochladen

Dateien in eine bestehende Anwendung committen