SDK JavaScript: referência de armazenamento
Todo método que gerencia buckets e objetos, com sua assinatura.
6 min lido·Nível referência·Revisado em 12 de out. de 2026
Este texto em inglês foi gerado automaticamente a partir do original em francês e ainda não foi revisado.
Esta página foi traduzida automaticamente. A versão em inglês é oficial.
#
Classe
Serviço de armazenamento
| Método | Descrição |
|---|---|
from(bucketId: string): StorageBucketClient | Retorna um cliente com escopo para um bucket específico (paridade DX Supabase). |
listBuckets(): Promise<AuraResponse<StorageBucket[]>> | Liste os buckets do projeto. |
getBucket(id: string): Promise<AuraResponse<StorageBucket>> | Lê um bucket pelo seu identificador. |
createBucket(name: string, options?: { public?: boolean; fileSizeLimit?: number; allowedMimeTypes?: string[]; }): Promise<AuraResponse<StorageBucket>> | Crie um balde. public (padrão false) torna seus objetos legíveis sem autenticação; fileSizeLimit (em bytes) e allowedMimeTypes limitam os arquivos aceitos. |
updateBucket(id: string, options?: { public?: boolean; fileSizeLimit?: number; allowedMimeTypes?: string[]; }): Promise<AuraResponse<StorageBucket>> | Atualiza um bucket existente (atualização PARCIAL: somente os campos fornecidos são enviados). |
deleteBucket(id: string): Promise<AuraResponse<null>> | Exclui um bucket pelo seu identificador. |
upload(bucketId: string, path: string, file: Blob | File | ArrayBuffer, options?: { contentType?: string; upsert?: boolean; metadata?: Record<string, string>; }): Promise<AuraResponse<UploadResult>> | Faça upload de um arquivo para um bucket. |
download(bucketId: string, path: string, options?: { transform?: ImageTransform; }): BlobDownloadBuilder | Download lento de um arquivo. |
list(bucketId: string, options?: { prefix?: string; limit?: number; offset?: number; cursor?: string; }): Promise<AuraResponse<FileEntry[]>> | Liste os arquivos em um bucket. |
remove(bucketId: string, paths: string[], options?: { permanent?: boolean; }): Promise<AuraResponse<null>> | Exclua um ou mais arquivos de um bucket. |
copy(bucketId: string, fromPath: string, toPath: string): Promise<AuraResponse<{ key: string; }>> | Copie um arquivo dentro de um bucket. |
move(bucketId: string, fromPath: string, toPath: string): Promise<AuraResponse<{ key: string; }>> | Mover/renomear um arquivo dentro de um bucket. |
getMetadata(bucketId: string, path: string): Promise<AuraResponse<ObjectMeta>> | Obtenha metadados de arquivo. |
createSignedUrl(bucketId: string, path: string, expiresInSeconds?: number, options?: { transform?: ImageTransform; }): Promise<AuraResponse<{ url: string; expires_in: number; }>> | Gere um URL de download assinado (temporário). |
createSignedUrls(bucketId: string, paths: string[], expiresInSeconds?: number, options?: { transform?: ImageTransform; }): Promise<AuraResponse<Array<{ path: string; url: string; expires_in: number; } | { path: string; error: AuraError; }>>> | Gera vários URLs assinados em uma única passagem (lote). |
createSignedUploadUrl(bucketId: string, path: string, expiresInSeconds?: number, options?: { upsert?: boolean; }): Promise<AuraResponse<{ url: string; expires_in: number; }>> | Gere um URL de upload assinado (PUT pré-assinado). |
getPublicUrl(bucketId: string, path: string, options?: { transform?: ImageTransform; }): string | Constrói um URL para um arquivo em um bucket. |
#
Classe
StorageBucketClient
Acesse o cliente com escopo para um bucket específico (paridade DX Supabase).
| Propriedade | Descrição |
|---|---|
readonly bucketId: string | Identificador do bucket ao qual este cliente está vinculado: todos os seus métodos atuam neste bucket. |
| Método | Descrição |
|---|---|
upload(path: string, file: Blob | File | ArrayBuffer, options?: { contentType?: string; upsert?: boolean; metadata?: Record<string, string>; }): Promise<AuraResponse<UploadResult>> | Faça upload de um arquivo para este bucket. |
download(path: string, options?: { transform?: ImageTransform; }): BlobDownloadBuilder | Baixe um arquivo deste bucket. |
list(options?: { prefix?: string; limit?: number; offset?: number; cursor?: string; }): Promise<AuraResponse<FileEntry[]>> | Liste os arquivos neste bucket. |
remove(paths: string[], options?: { permanent?: boolean; }): Promise<AuraResponse<null>> | Exclui um ou mais arquivos deste bucket. |
createSignedUrl(path: string, expiresInSeconds?: number, options?: { transform?: ImageTransform; }): Promise<AuraResponse<{ url: string; expires_in: number; }>> | Cria um URL assinado temporário para um arquivo neste bucket. |
createSignedUrls(paths: string[], expiresInSeconds?: number, options?: { transform?: ImageTransform; }): Promise<AuraResponse<Array<{ path: string; url: string; expires_in: number; } | { path: string; error: AuraError; }>>> | Cria vários URLs assinados em uma passagem para este bucket. |
createSignedUploadUrl(path: string, expiresInSeconds?: number, options?: { upsert?: boolean; }): Promise<AuraResponse<{ url: string; expires_in: number; }>> | Cria um URL de upload pré-assinado (PUT direto). |
getPublicUrl(path: string, options?: { transform?: ImageTransform; }): { data: { publicUrl: string; }; } | Retorna o URL público de um arquivo neste bucket. |
#
Classe
BlobDownloadBuilder
Download lento (Blob por padrão).
| Método | Descrição |
|---|---|
asStream(): StreamDownloadBuilder | Muda para leitura de streaming: o resultado se torna um ReadableStream em vez de um Blob carregado na memória. |
then<TR1 = AuraResponse<Blob>, TR2 = never>(onfulfilled?: ((v: AuraResponse<Blob>) => TR1 | PromiseLike<TR1>) | null, onrejected?: ((e: unknown) => TR2 | PromiseLike<TR2>) | null): Promise<TR1 | TR2> | Aciona o download (preguiçoso: a solicitação só começa em await); o resultado é memorizado. |
#
Classe
StreamDownloadBuilder
Fluxo variante — res.body (ReadableStream).
| Método | Descrição |
|---|---|
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> | Aciona download de streaming (preguiçoso); o resultado é memorizado. |
Página gerada
Esta página é gerada a partir das declarações de tipo e comentários do SDK, portanto, não pode desviar do código publicado. Para exemplos resolvidos, leia os guias.
Última atualização · 12 de out. de 2026