SDK JavaScript: upload e commit di file

Gli esempi usano il client api di Creare il client. appId è l’id di una delle tue app: api.account.me() le elenca.

Input accettati

apps.create() e apps.commit() accettano:

Input	Dove	Note
Un percorso di file (`string`)	Node.js, Deno, Bun	Aperto con `fs.openAsBlob` e trasmesso in streaming dal disco, mai caricato in memoria
`Blob` / `File`	Ovunque	Il nome di un `File` viene usato come nome del file
`Uint8Array` (o `Buffer`)	Ovunque

Sui runtime edge e nel browser, passa un Blob, un File o un Uint8Array: un percorso funziona solo dove esiste node:fs. Gli upload sono limitati a 100 MB. Un file più grande fallisce localmente con FILE_TOO_LARGE (status 0) prima che venga inviato qualsiasi cosa. Gli upload vengono trasmessi in streaming e non hanno timeout: passa un signal per annullarne uno.

Creare un’applicazione

apps.create(file) effettua il deploy di un .zip che contiene un file di configurazione squarecloud.app nella sua radice.

const app = await api.apps.create("./bot.zip");

console.log(app.id, app.name, app.ram, app.cpu, app.language.name, app.language.version);
console.log(app.domain);  // "<subdomain>.squareweb.app" for web apps, absent otherwise
console.log(app.cluster); // the cluster the app was placed on

Campo	Descrizione
`id`	L’id della nuova app
`name`	Nome preso dal file di configurazione
`description`	Presente solo se impostata
`domain`	Host completo `<subdomain>.squareweb.app`; assente per le app non web
`cluster`	Cluster su cui è stata collocata l’app
`ram` / `cpu`	Risorse allocate
`language`	`{ name, version }`

Fare il commit su un’applicazione

apps.commit(appId, file, { path, filename, signal }) carica un file in un’app esistente:

Un .zip viene estratto in path (per impostazione predefinita la radice dell’app).
Qualsiasi altro file finisce in path/<filename>.

Il nome del file è filename, altrimenti il nome del file stesso (percorso o File), altrimenti commit.zip.

// Unpack a zip at the root
await api.apps.commit(appId, "./build.zip");

// Unpack a zip into /src
await api.apps.commit(appId, "./patch.zip", { path: "/src" });

// A single file from memory: /src/index.js
await api.apps.commit(appId, new Blob([code]), { path: "/src", filename: "index.js" });

Un commit non riavvia l’app. Chiama apps.restart() per applicarlo.

Annullare un upload

const controller = new AbortController();
const timer = setTimeout(() => controller.abort(), 120_000);

try {
    await api.apps.create("./bot.zip", { signal: controller.signal });
} finally {
    clearTimeout(timer);
}

Un upload annullato viene rifiutato con il reason del signal.

Errori

Status	Codice	Quando
0	`FILE_TOO_LARGE`	Il file supera i 100 MB (verificato localmente)
400	`INVALID_FILE`, `INVALID_FILENAME`	Nessun file, o un nome di file con separatori di percorso, `..` o caratteri di controllo
400	`INVALID_PATH`	`path` contiene attraversamenti di percorso o metacaratteri della shell (commit)
400	`INSUFFICIENT_MEMORY`	Meno di 256 MB di memoria disponibile nel piano (create)
400	`COMMIT_FAILED`	Non è stato possibile applicare il commit (commit)
400	`UPLOAD_FAILED`, `STORAGE_UPLOAD_FAILED`, `CLUSTER_SELECTION_FAILED`	Non è stato possibile elaborare l’upload (create)
503	`CLUSTER_MAINTENANCE_TRY_LATER`	Il provisioning è sospeso per manutenzione (create)
503	`UPLOAD_BUSY`	Troppi upload in corso: ripetuto automaticamente

Un percorso locale che non può essere aperto lancia l’errore del file system, non un SquareCloudAPIError. Vedi Errori per l’elenco completo.

Prossimi passi

Gestire i file

Elenca, leggi, scrivi, sposta ed elimina i file di un’app.

Riferimento API dell'upload

Gli endpoint REST dietro questi metodi.

Upload dalla CLI

Le stesse azioni dal terminale.

CLI

VS Code

SDKs

SDK JavaScript: upload e commit di file

Input accettati

Creare un’applicazione

Fare il commit su un’applicazione

Annullare un upload

Errori

Prossimi passi

Gestire i file

Riferimento API dell'upload

Upload dalla CLI

​Input accettati

​Creare un’applicazione

​Fare il commit su un’applicazione

​Annullare un upload

​Errori

​Prossimi passi

Gestire i file

Riferimento API dell'upload

Upload dalla CLI

Input accettati

Creare un’applicazione

Fare il commit su un’applicazione

Annullare un upload

Errori

Prossimi passi