JavaScript SDK: opslagreferentie
Elke methode die buckets en objecten beheert, met zijn handtekening.
6 min lezen·Niveau referentie·Herzien op 12 okt 2026
Deze Engelse tekst is automatisch gegenereerd op basis van het Franse origineel en is nog niet beoordeeld.
Deze pagina is automatisch vertaald. De Engelse versie is gezaghebbend.
#
Klasse
OpslagService
| Methode | Beschrijving |
|---|---|
from(bucketId: string): StorageBucketClient | Retourneert een client binnen het bereik van een specifieke bucket (DX-pariteit Supabase). |
listBuckets(): Promise<AuraResponse<StorageBucket[]>> | Maak een lijst van de projectbuckets. |
getBucket(id: string): Promise<AuraResponse<StorageBucket>> | Leest een bucket op basis van zijn identificatie. |
createBucket(name: string, options?: { public?: boolean; fileSizeLimit?: number; allowedMimeTypes?: string[]; }): Promise<AuraResponse<StorageBucket>> | Maak een emmer. public (standaard false) maakt zijn objecten leesbaar zonder authenticatie; fileSizeLimit (in bytes) en allowedMimeTypes beperken de geaccepteerde bestanden. |
updateBucket(id: string, options?: { public?: boolean; fileSizeLimit?: number; allowedMimeTypes?: string[]; }): Promise<AuraResponse<StorageBucket>> | Werkt een bestaande bucket bij (GEDEELTELIJKE update: alleen de opgegeven velden worden verzonden). |
deleteBucket(id: string): Promise<AuraResponse<null>> | Verwijdert een bucket op basis van zijn ID. |
upload(bucketId: string, path: string, file: Blob | File | ArrayBuffer, options?: { contentType?: string; upsert?: boolean; metadata?: Record<string, string>; }): Promise<AuraResponse<UploadResult>> | Upload een bestand naar een bucket. |
download(bucketId: string, path: string, options?: { transform?: ImageTransform; }): BlobDownloadBuilder | Lui downloaden van een bestand. |
list(bucketId: string, options?: { prefix?: string; limit?: number; offset?: number; cursor?: string; }): Promise<AuraResponse<FileEntry[]>> | Geef bestanden weer in een bucket. |
remove(bucketId: string, paths: string[], options?: { permanent?: boolean; }): Promise<AuraResponse<null>> | Verwijder een of meer bestanden uit een bucket. |
copy(bucketId: string, fromPath: string, toPath: string): Promise<AuraResponse<{ key: string; }>> | Kopieer een bestand binnen een bucket. |
move(bucketId: string, fromPath: string, toPath: string): Promise<AuraResponse<{ key: string; }>> | Verplaats/hernoem een bestand binnen een bucket. |
getMetadata(bucketId: string, path: string): Promise<AuraResponse<ObjectMeta>> | Metagegevens van bestanden ophalen. |
createSignedUrl(bucketId: string, path: string, expiresInSeconds?: number, options?: { transform?: ImageTransform; }): Promise<AuraResponse<{ url: string; expires_in: number; }>> | Genereer een ondertekende (tijdelijke) download-URL. |
createSignedUrls(bucketId: string, paths: string[], expiresInSeconds?: number, options?: { transform?: ImageTransform; }): Promise<AuraResponse<Array<{ path: string; url: string; expires_in: number; } | { path: string; error: AuraError; }>>> | Genereert meerdere ondertekende URL's in één keer (batch). |
createSignedUploadUrl(bucketId: string, path: string, expiresInSeconds?: number, options?: { upsert?: boolean; }): Promise<AuraResponse<{ url: string; expires_in: number; }>> | Genereer een ondertekende upload-URL (vooraf ondertekende PUT). |
getPublicUrl(bucketId: string, path: string, options?: { transform?: ImageTransform; }): string | Construeert een URL naar een bestand in een bucket. |
#
Klasse
StorageBucketClient
Toegang tot de client die is gericht op een specifieke bucket (DX-pariteit Supabase).
| Eigendom | Beschrijving |
|---|---|
readonly bucketId: string | Identificatie van de bucket waaraan deze klant is gekoppeld: al zijn methoden werken op deze bucket. |
| Methode | Beschrijving |
|---|---|
upload(path: string, file: Blob | File | ArrayBuffer, options?: { contentType?: string; upsert?: boolean; metadata?: Record<string, string>; }): Promise<AuraResponse<UploadResult>> | Upload een bestand naar deze bucket. |
download(path: string, options?: { transform?: ImageTransform; }): BlobDownloadBuilder | Download een bestand uit deze bucket. |
list(options?: { prefix?: string; limit?: number; offset?: number; cursor?: string; }): Promise<AuraResponse<FileEntry[]>> | Maak een lijst van de bestanden in deze bucket. |
remove(paths: string[], options?: { permanent?: boolean; }): Promise<AuraResponse<null>> | Verwijdert een of meer bestanden uit deze bucket. |
createSignedUrl(path: string, expiresInSeconds?: number, options?: { transform?: ImageTransform; }): Promise<AuraResponse<{ url: string; expires_in: number; }>> | Creëert een tijdelijk ondertekende URL voor een bestand in deze bucket. |
createSignedUrls(paths: string[], expiresInSeconds?: number, options?: { transform?: ImageTransform; }): Promise<AuraResponse<Array<{ path: string; url: string; expires_in: number; } | { path: string; error: AuraError; }>>> | Maakt in één keer meerdere ondertekende URL's voor deze bucket. |
createSignedUploadUrl(path: string, expiresInSeconds?: number, options?: { upsert?: boolean; }): Promise<AuraResponse<{ url: string; expires_in: number; }>> | Creëert een vooraf ondertekende upload-URL (direct PUT). |
getPublicUrl(path: string, options?: { transform?: ImageTransform; }): { data: { publicUrl: string; }; } | Retourneert de openbare URL van een bestand in deze bucket. |
#
Klasse
BlobDownloadBuilder
Luie download (standaard Blob).
| Methode | Beschrijving |
|---|---|
asStream(): StreamDownloadBuilder | Schakelt over naar streaming lezen: het resultaat wordt een ReadableStream in plaats van een Blob die in het geheugen is geladen. |
then<TR1 = AuraResponse<Blob>, TR2 = never>(onfulfilled?: ((v: AuraResponse<Blob>) => TR1 | PromiseLike<TR1>) | null, onrejected?: ((e: unknown) => TR2 | PromiseLike<TR2>) | null): Promise<TR1 | TR2> | Activeert de download (lui: het verzoek begint pas bij await); het resultaat wordt onthouden. |
#
Klasse
StreamDownloadBuilder
Variante flux — res.body (ReadableStream).
| Methode | Beschrijving |
|---|---|
then<TR1 = AuraResponse<ReadableStream<Uint8Array>>, TR2 = never>(onfulfilled?: ((v: AuraResponse<ReadableStream<Uint8Array>>) => TR1 | PromiseLike<TR1>) | null, onrejected?: ((e: unknown) => TR2 | PromiseLike<TR2>) | null): Promise<TR1 | TR2> | Triggers streaming (lui) downloaden; het resultaat wordt onthouden. |
Gegenereerde pagina
Deze pagina wordt gegenereerd op basis van de typedeclaraties en opmerkingen van de SDK, zodat deze niet kan afwijken van de gepubliceerde code. Lees de handleidingen voor uitgewerkte voorbeelden.
Laatst bijgewerkt · 12 okt 2026