オーラベースのロゴ
オーラベースドキュメント
ドキュメント›JavaScript SDK reference›Storage reference

JavaScript SDK: ストレージリファレンス

バケットとオブジェクトを管理するすべてのメソッドとそのシグネチャ。

6 分 読み取り·レベル 参照·2026/10/12 に改訂
この英語のテキストはフランス語のオリジナルから自動的に生成されたもので、まだレビューされていません。
このページは自動翻訳されました。英語版が正式です。
#
クラス

ストレージサービス

方法説明
from(bucketId: string): StorageBucketClient特定のバケット (DX パリティ Supabase) をスコープとするクライアントを返します。
listBuckets(): Promise<AuraResponse<StorageBucket[]>>プロジェクト バケットをリストします。
getBucket(id: string): Promise<AuraResponse<StorageBucket>>バケットをその識別子で読み取ります。
createBucket(name: string, options?: { public?: boolean; fileSizeLimit?: number; allowedMimeTypes?: string[]; }): Promise<AuraResponse<StorageBucket>>バケットを作成します。 public (デフォルト false) は、認証なしでそのオブジェクトを読み取り可能にします。 fileSizeLimit (バイト単位) および allowedMimeTypes は、受け入れられるファイルを制限します。
updateBucket(id: string, options?: { public?: boolean; fileSizeLimit?: number; allowedMimeTypes?: string[]; }): Promise<AuraResponse<StorageBucket>>既存のバケットを更新します (部分更新: 指定されたフィールドのみが送信されます)。
deleteBucket(id: string): Promise<AuraResponse<null>>バケットをその識別子に基づいて削除します。
upload(bucketId: string, path: string, file: Blob | File | ArrayBuffer, options?: { contentType?: string; upsert?: boolean; metadata?: Record<string, string>; }): Promise<AuraResponse<UploadResult>>ファイルをバケットにアップロードします。
download(bucketId: string, path: string, options?: { transform?: ImageTransform; }): BlobDownloadBuilderファイルの遅延ダウンロード。
list(bucketId: string, options?: { prefix?: string; limit?: number; offset?: number; cursor?: string; }): Promise<AuraResponse<FileEntry[]>>バケット内のファイルを一覧表示します。
remove(bucketId: string, paths: string[], options?: { permanent?: boolean; }): Promise<AuraResponse<null>>バケットから 1 つ以上のファイルを削除します。
copy(bucketId: string, fromPath: string, toPath: string): Promise<AuraResponse<{ key: string; }>>バケット内のファイルをコピーします。
move(bucketId: string, fromPath: string, toPath: string): Promise<AuraResponse<{ key: string; }>>バケット内のファイルを移動/名前変更します。
getMetadata(bucketId: string, path: string): Promise<AuraResponse<ObjectMeta>>ファイルのメタデータを取得します。
createSignedUrl(bucketId: string, path: string, expiresInSeconds?: number, options?: { transform?: ImageTransform; }): Promise<AuraResponse<{ url: string; expires_in: number; }>>署名付きの (一時的な) ダウンロード 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; }>>>1 つのパス (バッチ) で複数の署名付き URL を生成します。
createSignedUploadUrl(bucketId: string, path: string, expiresInSeconds?: number, options?: { upsert?: boolean; }): Promise<AuraResponse<{ url: string; expires_in: number; }>>署名付きアップロード URL (署名付き PUT) を生成します。
getPublicUrl(bucketId: string, path: string, options?: { transform?: ImageTransform; }): stringバケット内のファイルへの URL を構築します。
#
クラス

ストレージバケットクライアント

特定のバケットをスコープとするクライアントにアクセスします (DX パリティ Supabase)。

プロパティ説明
readonly bucketId: stringこのクライアントがリンクされているバケットの識別子: すべてのメソッドはこのバケットに対して動作します。
方法説明
upload(path: string, file: Blob | File | ArrayBuffer, options?: { contentType?: string; upsert?: boolean; metadata?: Record<string, string>; }): Promise<AuraResponse<UploadResult>>このバケットにファイルをアップロードします。
download(path: string, options?: { transform?: ImageTransform; }): BlobDownloadBuilderこのバケットからファイルをダウンロードします。
list(options?: { prefix?: string; limit?: number; offset?: number; cursor?: string; }): Promise<AuraResponse<FileEntry[]>>このバケット内のファイルを一覧表示します。
remove(paths: string[], options?: { permanent?: boolean; }): Promise<AuraResponse<null>>このバケットから 1 つ以上のファイルを削除します。
createSignedUrl(path: string, expiresInSeconds?: number, options?: { transform?: ImageTransform; }): Promise<AuraResponse<{ url: string; expires_in: number; }>>このバケット内のファイルの一時的な署名付き URL を作成します。
createSignedUrls(paths: string[], expiresInSeconds?: number, options?: { transform?: ImageTransform; }): Promise<AuraResponse<Array<{ path: string; url: string; expires_in: number; } | { path: string; error: AuraError; }>>>このバケットの 1 つのパスで複数の署名付き URL を作成します。
createSignedUploadUrl(path: string, expiresInSeconds?: number, options?: { upsert?: boolean; }): Promise<AuraResponse<{ url: string; expires_in: number; }>>署名付きアップロード URL (直接 PUT) を作成します。
getPublicUrl(path: string, options?: { transform?: ImageTransform; }): { data: { publicUrl: string; }; }このバケット内のファイルのパブリック URL を返します。
#
クラス

BlobDownloadBuilder

遅延ダウンロード (デフォルトでは BLOB)。

方法説明
asStream(): StreamDownloadBuilderストリーミング読み取りに切り替えます。結果はメモリにロードされる Blob ではなく ReadableStream になります。
then<TR1 = AuraResponse<Blob>, TR2 = never>(onfulfilled?: ((v: AuraResponse<Blob>) => TR1 | PromiseLike<TR1>) | null, onrejected?: ((e: unknown) => TR2 | PromiseLike<TR2>) | null): Promise<TR1 | TR2>ダウンロードをトリガーします (遅延: リクエストは awaitでのみ開始されます)。結果は記憶されます。
#
クラス

ストリームダウンロードビルダー

バリアント フラックス — res.body (ReadableStream)。

方法説明
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>ストリーミング (遅延) ダウンロードをトリガーします。結果は記憶されます。
生成されたページ

このページは SDK の型宣言とコメントから生成されるため、公開されたコードから逸脱することはできません。実用的な例については、ガイドを参照してください。