SDK JavaScript: gestire i file dell'app

Il file manager si trova su api.apps.files. Ogni metodo accetta prima l’id dell’app, poi un percorso all’interno dell’app. I percorsi hanno al massimo 256 caratteri. Gli esempi usano il client api di Creare il client. appId è l’id di una delle tue app: api.account.me() le elenca.

Elencare una directory

files.list(appId, path?) elenca una directory (la radice dell’app quando path è omesso).

for (const entry of await api.apps.files.list(appId, "/src")) {
    console.log(entry.type, entry.name, entry.size, entry.lastModified);
}

Campo	Tipo	Descrizione
`name`	`string`	Nome della voce
`type`	`"file" \| "directory"`	Tipo di voce
`size`	`number?`	Dimensione in byte. Assente in alcune voci di directory
`lastModified`	`number \| null?`	ms Unix (può includere una parte frazionaria); `null` quando non leggibile

Una directory che non esiste produce 404 FILE_NOT_FOUND. Un percorso che il file manager non espone produce 403 BLOCKED_PATH.

Leggere un file

files.read(appId, path) restituisce i byte del file come Uint8Array. I file sono limitati a 10 MB: uno più grande produce 413 FILE_TOO_LARGE.

const bytes = await api.apps.files.read(appId, "/config.json");
const text = new TextDecoder().decode(bytes);

console.log(JSON.parse(text));

Scrivere un file

files.write(appId, path, content, { signal }) crea o sovrascrive un file.

Una string viene inviata come testo semplice.
Un Uint8Array viene inviato in base64, quindi qualsiasi contenuto binario arriva intatto.
Un contenuto vuoto ("" o byte vuoti) crea un file vuoto.

// Text
await api.apps.files.write(appId, "/config.json", JSON.stringify({ debug: false }));

// Binary
const image = new Uint8Array(await (await fetch(imageUrl)).arrayBuffer());
await api.apps.files.write(appId, "/assets/logo.png", image);

Un contenuto oltre i 10 MB fallisce localmente con FILE_TOO_LARGE (status 0) prima che venga inviato qualsiasi cosa. Un contenuto oltre 1 MiB viene inviato senza timeout, come un upload: passa { signal } per annullarlo. Per file più grandi, usa apps.commit().

La scrittura non riavvia l’app. Chiama apps.restart() per applicare la modifica.

Spostare o rinominare un file

await api.apps.files.move(appId, "/config.json", "/config.old.json");

Eliminare un file

await api.apps.files.delete(appId, "/config.old.json");

Errori

Status	Codice	Quando
0	`FILE_TOO_LARGE`	Contenuto di `write` oltre 10 MB (verificato localmente)
400	`INVALID_PATH`	Il percorso non supera la validazione (attraversamento, caratteri non validi, troppo lungo), oppure `move` verso lo stesso percorso
400	`DELETE_FAILED`, `RENAME_FAILED`	Il cluster non è riuscito a eliminare o rinominare il file
403	`BLOCKED_PATH`	Il percorso non è esposto dal file manager
403	`PERMISSION_DENIED`	Il tuo ruolo nel workspace non può toccare un file riservato (come `.env`)
404	`FILE_NOT_FOUND`	Il file o la directory non esiste
413	`FILE_TOO_LARGE`	`read` di un file oltre 10 MB
429	`KEEP_CALM`	Più di 10 scritture in 5 secondi

Vedi Errori per i codici che qualsiasi chiamata può restituire.

Prossimi passi

Variabili d'ambiente

Leggi e modifica le variabili di un’app.

Riferimento API del file manager

Gli endpoint REST dietro questi metodi.

Gestire i file dalla CLI

Le stesse azioni dal terminale.

CLI

VS Code

SDKs

SDK JavaScript: gestire i file dell'app

Elencare una directory

Leggere un file

Scrivere un file

Spostare o rinominare un file

Eliminare un file

Errori

Prossimi passi

Variabili d'ambiente

Riferimento API del file manager

Gestire i file dalla CLI

​Elencare una directory

​Leggere un file

​Scrivere un file

​Spostare o rinominare un file

​Eliminare un file

​Errori

​Prossimi passi

Variabili d'ambiente

Riferimento API del file manager

Gestire i file dalla CLI

Elencare una directory

Leggere un file

Scrivere un file

Spostare o rinominare un file

Eliminare un file

Errori

Prossimi passi