storage package

Cloud Storage for Firebase

関数

クラス

列挙値

インターフェース

変数

型エイリアス

関数（アプリ、...）

getStorage(app, bucketUrl)

指定された Firebase アプリの FirebaseStorage インスタンスを取得します。

署名:

export declare function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStorage;

パラメータ

戻り値:

FirebaseStorage

FirebaseStorage インスタンス。

function(storage, ...)

connectStorageEmulator（ストレージ、ホスト、ポート、オプション）

この FirebaseStorage インスタンスを、Cloud Storage エミュレータと通信するように変更します。

署名:

export declare function connectStorageEmulator(storage: FirebaseStorage, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

パラメータ

戻り値:

void

ref(ストレージ, url)

指定された URL の StorageReference を返します。

署名:

export declare function ref(storage: FirebaseStorage, url?: string): StorageReference;

パラメータ

戻り値:

StorageReference

関数（参照、...）

deleteObject（参照）

この場所のオブジェクトを削除します。

署名:

export declare function deleteObject(ref: StorageReference): Promise<void>;

パラメータ

戻り値:

約束 <void>

削除が成功した場合に解決される Promise。

getBlob(ref, maxDownloadSizeBytes)

オブジェクトの場所にデータをダウンロードします。オブジェクトが見つからない場合はエラーを返します。

この機能を使用するには、Cloud Storage バケットでアプリの配信元を許可リストに登録する必要があります。関連情報: https://cloud.google.com/storage/docs/configure-cors

この API は Node では使用できません。

署名:

export declare function getBlob(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<Blob>;

パラメータ

戻り値:

Promise<Blob>

オブジェクトのバイトを含む blob で解決される Promise

getBytes(ref, maxDownloadSizeBytes)

オブジェクトの場所にデータをダウンロードします。オブジェクトが見つからない場合はエラーを返します。

この機能を使用するには、Cloud Storage バケットでアプリの配信元を許可リストに登録する必要があります。関連情報: https://cloud.google.com/storage/docs/configure-cors

署名:

export declare function getBytes(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<ArrayBuffer>;

パラメータ

戻り値:

Promise<配列バッファ>

オブジェクトのバイトを含む Promise

getDownloadURL(ref)

指定された StorageReference のダウンロード URL を返します。

署名:

export declare function getDownloadURL(ref: StorageReference): Promise<string>;

パラメータ

戻り値:

Promise<文字列>

このオブジェクトのダウンロード URL で解決される Promise。

getMetadata(ref)

このオブジェクトのメタデータで解決される Promise。このオブジェクトが存在しない場合、またはメタデータを取得できない場合、Promise は拒否されます。

署名:

export declare function getMetadata(ref: StorageReference): Promise<FullMetadata>;

パラメータ

戻り値:

Promise <FullMetadata>

getStream(ref, maxDownloadSizeBytes)

オブジェクトの場所にデータをダウンロードします。オブジェクトが見つからない場合はエラーイベントが発生します。

この API は Node でのみ使用できます。

署名:

export declare function getStream(ref: StorageReference, maxDownloadSizeBytes?: number): ReadableStream;

パラメータ

戻り値:

ReadableStream

オブジェクトのデータがバイトとして格納されたストリーム

list(ref, options)

このストレージ参照の下にあるアイテム（ファイル）と接頭辞（フォルダ）をリストします。

List API は Firebase ルール バージョン 2 でのみ使用できます。

GCS は Key-blob ストアです。Firebase Storage では「/」のセマンティクスが必須区切ります。詳しくは、GCS の List API をご覧ください。

Firebase ルールのセマンティクスを遵守するため、Firebase Storage ではパスが「/」で終わるオブジェクトはサポートされていませんまたは 2 つの連続する「/」を含めることができます。これらのサポートされていないオブジェクトは、Firebase Storage List API によってフィルタされます。サポートされていないオブジェクトが多すぎると、list() が失敗することがあります。

署名:

export declare function list(ref: StorageReference, options?: ListOptions): Promise<ListResult>;

パラメータ

戻り値:

Promise<ListResult>

アイテムと接頭辞で解決される Promise。prefixes にはサブフォルダへの参照が含まれ、items にはこのフォルダ内のオブジェクトへの参照が含まれます。nextPageToken を使用すると、残りの結果を取得できます。

listAll（参照）

このストレージ参照に含まれるすべてのアイテム（ファイル）と接頭辞（フォルダ）をリストします。

これは結果がなくなるまで list() を繰り返し呼び出すヘルパー メソッドです。デフォルトのページ分割サイズは 1,000 です。

署名:

export declare function listAll(ref: StorageReference): Promise<ListResult>;

パラメータ

戻り値:

Promise<ListResult>

現在のストレージ参照の下のすべてのアイテムと接頭辞で解決される Promise。prefixes にはサブディレクトリへの参照が含まれ、items にはこのフォルダ内のオブジェクトへの参照が含まれます。nextPageToken は返されません。

updateMetadata(ref, metadata)

このオブジェクトのメタデータを更新します。

署名:

export declare function updateMetadata(ref: StorageReference, metadata: SettableMetadata): Promise<FullMetadata>;

パラメータ

戻り値:

Promise <FullMetadata>

このオブジェクトの新しいメタデータで解決される Promise。

UploadBytes(ref, data, metadata)

このオブジェクトの場所にデータをアップロードします。アップロードは再開できません。

署名:

export declare function uploadBytes(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): Promise<UploadResult>;

パラメータ

戻り値:

Promise <UploadResult>

UploadResult を含む Promise

UploadBytesResumable(ref, data, metadata)

このオブジェクトの場所にデータをアップロードします。アップロードの一時停止と再開が可能で、進行状況の更新も表示されます。

署名:

export declare function uploadBytesResumable(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): UploadTask;

パラメータ

戻り値:

UploadTask。

UploadTask

UploadString(ref, value, format, metadata)

このオブジェクトの場所に文字列をアップロードします。アップロードは再開できません。

署名:

export declare function uploadString(ref: StorageReference, value: string, format?: StringFormat, metadata?: UploadMetadata): Promise<UploadResult>;

パラメータ

戻り値:

Promise <UploadResult>

UploadResult を含む Promise

function(storageOrRef, ...)

ref(storageOrRef, path)

デフォルト バケット内の指定されたパスの StorageReference を返します。

署名:

export declare function ref(storageOrRef: FirebaseStorage | StorageReference, path?: string): StorageReference;

パラメータ

戻り値:

StorageReference

StringFormat

アップロード可能な文字列形式の列挙型。

署名:

StringFormat: {
    readonly RAW: "raw";
    readonly BASE64: "base64";
    readonly BASE64URL: "base64url";
    readonly DATA_URL: "data_url";
}

StringFormat

アップロード可能な文字列形式の列挙型。

署名:

export declare type StringFormat = (typeof StringFormat)[keyof typeof StringFormat];

TaskEvent

タスクでトリガーされるイベント。

署名:

export declare type TaskEvent = 'state_changed';

タスクの状態

実行中のアップロードの現在の状態を表します。

署名:

export declare type TaskState = 'running' | 'paused' | 'success' | 'canceled' | 'error';

StorageErrorCode

StorageError オブジェクトに追加可能なエラーコード。

署名:

export declare enum StorageErrorCode 

列挙型メンバー