storage package

Firebase 用クラウド ストレージ

機能

関数説明
関数(アプリ、...)
getStorage(アプリ、バケットUrl)指定された Firebase アプリのFirebaseStorageインスタンスを取得します。
機能(ストレージ、...)
connectStorageEmulator(ストレージ、ホスト、ポート、オプション) Cloud Storage エミュレータと通信できるように、このFirebaseStorageインスタンスを変更します。
ref(ストレージ、URL)指定された URL のStorageReferenceを返します。
関数(ref, ...)
削除オブジェクト(参照)この場所にあるオブジェクトを削除します。
getBlob(ref, maxDownloadSizeBytes)オブジェクトの場所にデータをダウンロードします。オブジェクトが見つからない場合はエラーを返します。この機能を使用するには、Cloud Storage バケット内のアプリのオリジンをホワイトリストに登録する必要があります。 https://cloud.google.com/storage/docs/cconfiguring-cors も参照してください。この API は Node では使用できません。
getBytes(ref, maxDownloadSizeBytes)オブジェクトの場所にデータをダウンロードします。オブジェクトが見つからない場合はエラーを返します。この機能を使用するには、Cloud Storage バケット内のアプリのオリジンをホワイトリストに登録する必要があります。 https://cloud.google.com/storage/docs/cconfiguring-cors も参照してください。
getDownloadURL(参照)指定されたStorageReferenceのダウンロード URL を返します。
getメタデータ(参照)このオブジェクトのメタデータを使用して解決されるPromise 。このオブジェクトが存在しない場合、またはメタデータを取得できない場合、Promise は拒否されます。
getStream(ref, maxDownloadSizeBytes)オブジェクトの場所にデータをダウンロードします。オブジェクトが見つからない場合はエラー イベントを発生させます。この API は Node.js でのみ使用できます。
list(参照、オプション)このストレージ参照の下の項目 (ファイル) とプレフィックス (フォルダー) をリストします。 List API は Firebase ルール バージョン 2 でのみ使用できます。 GCS はキーブロブ ストアです。 Firebase Storage は、「/」で区切られたフォルダー構造のセマンティクスを強制します。詳細については、GCS の List API を参照してください。 Firebase ルールのセマンティクスに準拠するため、Firebase Storage は、パスが「/」で終わるオブジェクト、または 2 つの連続する「/」を含むオブジェクトをサポートしません。 Firebase Storage List API は、これらのサポートされていないオブジェクトをフィルタリングします。バケット内にサポートされていないオブジェクトが多すぎると、list() が失敗する可能性があります。
リストすべて(参照)このストレージ参照の下にあるすべてのアイテム (ファイル) とプレフィックス (フォルダー) をリストします。これは、結果がなくなるまで list() を繰り返し呼び出すためのヘルパー メソッドです。デフォルトのページネーション サイズは 1000 です。注: この操作の実行中にオブジェクトが変更された場合、結果は一貫性がなくなる可能性があります。警告: listAll結果が多すぎる場合、リソースを消費しすぎる可能性があります。
updateMetadata(ref, メタデータ)このオブジェクトのメタデータを更新します。
UploadBytes(参照、データ、メタデータ)このオブジェクトの場所にデータをアップロードします。アップロードは再開できません。
UploadBytesResumable(参照、データ、メタデータ)このオブジェクトの場所にデータをアップロードします。アップロードは一時停止および再開でき、進行状況の更新が公開されます。
UploadString(参照、値、形式、メタデータ)このオブジェクトの場所に文字列をアップロードします。アップロードは再開できません。
関数(ストレージまたは参照, ...)
ref(ストレージまたは参照、パス)デフォルトのバケット内の指定されたパスのStorageReferenceを返します。

クラス

クラス説明
ストレージエラーFirebase Storage SDK によって返されたエラー。

列挙

列挙説明
ストレージエラーコードStorageErrorオブジェクトに付加できるエラー コード。

インターフェース

インターフェース説明
FirebaseストレージFirebase ストレージ インスタンス。
フルメタデータ読み取り専用プロパティを含む、オブジェクト メタデータの完全なセット。
リストオプションlist()オプションは受け入れます。
リスト結果list() によって返される結果。
設定可能なメタデータいつでも設定できるオブジェクトのメタデータ。
ストレージオブザーバーFirebase Storage のストリーム オブザーバー。
ストレージリファレンスGoogle Cloud Storage オブジェクトへの参照を表します。開発者は、オブジェクトのアップロード、ダウンロード、削除に加えて、オブジェクトのメタデータを取得/設定できます。
メタデータのアップロードアップロード時に設定できるオブジェクトのメタデータ。
アップロード結果再開不可能なアップロードから返された結果。
アップロードタスクオブジェクトをアップロードするプロセスを表します。アップロードを監視および管理できます。
タスクスナップショットのアップロードアップロードタスクの現在の状態に関するデータを保持します。

変数

変数説明
文字列形式アップロードに使用できる文字列形式の列挙。

タイプエイリアス

タイプエイリアス説明
文字列形式アップロードに使用できる文字列形式の列挙。
タスクイベントタスクでトリガーされるイベント。
タスクの状態実行中のアップロードの現在の状態を表します。

関数(アプリ、...)

getStorage(アプリ、バケットUrl)

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

サイン:

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

パラメーター

パラメータタイプ説明
アプリFirebaseApp FirebaseStorageインスタンスを取得する Firebase アプリ。
バケットURLFirebase ストレージ バケットへの gs:// URL。渡されない場合、アプリのデフォルトのストレージ バケットが使用されます。

戻り値:

Firebaseストレージ

FirebaseStorageインスタンス。

機能(ストレージ、...)

connectStorageEmulator(ストレージ、ホスト、ポート、オプション)

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

サイン:

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

パラメーター

パラメータタイプ説明
ストレージFirebaseストレージFirebaseStorageインスタンス
ホストエミュレータホスト (例: localhost)
ポート番号エミュレータのポート (例: 5001)
オプション{mockUserToken?: EmulatorMockTokenOptions |弦; }エミュレータのオプション。 options.mockUserTokenは、セキュリティ ルールの単体テストに使用する模擬認証トークンです。

戻り値:

空所

ref(ストレージ、URL)

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

サイン:

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

パラメーター

パラメータタイプ説明
ストレージFirebaseストレージFirebaseStorageインスタンス。
URLURL。空の場合は、ルート参照を返します。

戻り値:

ストレージリファレンス

関数(ref, ...)

削除オブジェクト(参照)

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

サイン:

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

パラメーター

パラメータタイプ説明
参照ストレージリファレンス削除するオブジェクトのStorageReference

戻り値:

約束<無効>

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

getBlob(ref, maxDownloadSizeBytes)

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

この機能を使用するには、Cloud Storage バケット内のアプリのオリジンをホワイトリストに登録する必要があります。 https://cloud.google.com/storage/docs/cconfiguring-cors も参照してください。

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

サイン:

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

パラメーター

パラメータタイプ説明
参照ストレージリファレンスデータをダウンロードする StorageReference。
maxDownloadSizeBytes番号設定されている場合、取得できる最大許容サイズ (バイト単位)。

戻り値:

約束<Blob>

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

getBytes(ref, maxDownloadSizeBytes)

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

この機能を使用するには、Cloud Storage バケット内のアプリのオリジンをホワイトリストに登録する必要があります。 https://cloud.google.com/storage/docs/cconfiguring-cors も参照してください。

サイン:

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

パラメーター

パラメータタイプ説明
参照ストレージリファレンスデータをダウンロードする StorageReference。
maxDownloadSizeBytes番号設定されている場合、取得できる最大許容サイズ (バイト単位)。

戻り値:

Promise<ArrayBuffer>

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

getDownloadURL(参照)

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

サイン:

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

パラメーター

パラメータタイプ説明
参照ストレージリファレンスダウンロード URL を取得するStorageReference

戻り値:

約束<文字列>

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

getメタデータ(参照)

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

サイン:

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

パラメーター

パラメータタイプ説明
参照ストレージリファレンスメタデータを取得するStorageReference

戻り値:

Promise< FullMetadata >

getStream(ref, maxDownloadSizeBytes)

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

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

サイン:

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

パラメーター

パラメータタイプ説明
参照ストレージリファレンスデータをダウンロードする StorageReference。
maxDownloadSizeBytes番号設定されている場合、取得できる最大許容サイズ (バイト単位)。

戻り値:

NodeJS.ReadableStream

オブジェクトのデータをバイトとして含むストリーム

list(参照、オプション)

このストレージ参照の下の項目 (ファイル) とプレフィックス (フォルダー) をリストします。

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

GCS はキーブロブ ストアです。 Firebase Storage は、「/」で区切られたフォルダー構造のセマンティクスを強制します。詳細については、GCS の List API を参照してください。

Firebase ルールのセマンティクスに準拠するため、Firebase Storage は、パスが「/」で終わるオブジェクト、または 2 つの連続する「/」を含むオブジェクトをサポートしません。 Firebase Storage List API は、これらのサポートされていないオブジェクトをフィルタリングします。バケット内にサポートされていないオブジェクトが多すぎると、list() が失敗する可能性があります。

サイン:

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

パラメーター

パラメータタイプ説明
参照ストレージリファレンスリストを取得するStorageReference
オプションリストオプション詳細については、 「ListOptions」を参照してください。

戻り値:

Promise< ListResult >

項目と接頭辞で解決されるPromiseprefixesにはサブフォルダーへの参照が含まれ、 itemsはこのフォルダー内のオブジェクトへの参照が含まれます。 nextPageToken使用して残りの結果を取得できます。

リストすべて(参照)

このストレージ参照の下にあるすべてのアイテム (ファイル) とプレフィックス (フォルダー) をリストします。

これは、結果がなくなるまで list() を繰り返し呼び出すためのヘルパー メソッドです。デフォルトのページネーション サイズは 1000 です。

サイン:

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

パラメーター

パラメータタイプ説明
参照ストレージリファレンスリストを取得するStorageReference

戻り値:

Promise< ListResult >

現在のストレージ参照にあるすべての項目とプレフィックスで解決されるPromiseprefixesにはサブディレクトリへの参照が含まれ、 itemsはこのフォルダー内のオブジェクトへの参照が含まれます。 nextPageTokenは返されません。

updateMetadata(ref, メタデータ)

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

サイン:

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

パラメーター

パラメータタイプ説明
参照ストレージリファレンスメタデータを更新するStorageReference
メタデータ設定可能なメタデータオブジェクトの新しいメタデータ。明示的に設定された値のみが変更されます。値を明示的に null に設定すると、メタデータが削除されます。

戻り値:

Promise< FullMetadata >

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

UploadBytes(参照、データ、メタデータ)

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

サイン:

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

パラメーター

パラメータタイプ説明
参照ストレージリファレンスデータをアップロードする必要があるStorageReference
データブロブ | Uint8Array |配列バッファアップロードするデータ。
メタデータメタデータのアップロードアップロードするデータのメタデータ。

戻り値:

Promise< UploadResult >

UploadResult を含む Promise

UploadBytesResumable(参照、データ、メタデータ)

このオブジェクトの場所にデータをアップロードします。アップロードは一時停止および再開でき、進行状況の更新が公開されます。

サイン:

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

パラメーター

パラメータタイプ説明
参照ストレージリファレンスデータをアップロードする必要があるStorageReference
データブロブ | Uint8Array |配列バッファアップロードするデータ。
メタデータメタデータのアップロードアップロードするデータのメタデータ。

戻り値:

アップロードタスク

アップロードタスク

UploadString(参照、値、形式、メタデータ)

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

サイン:

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

パラメーター

パラメータタイプ説明
参照ストレージリファレンス文字列をアップロードする必要があるStorageReference
価値アップロードする文字列。
フォーマット文字列形式アップロードする文字列の形式。
メタデータメタデータのアップロードアップロードする文字列のメタデータ。

戻り値:

Promise< UploadResult >

UploadResult を含む Promise

関数(ストレージまたは参照, ...)

ref(ストレージまたは参照、パス)

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

サイン:

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

パラメーター

パラメータタイプ説明
ストレージまたは参照ファイアベースストレージ|ストレージリファレンスFirebaseStorageまたはStorageReference
パス

戻り値:

ストレージリファレンス

文字列形式

アップロードに使用できる文字列形式の列挙。

サイン:

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

文字列形式

アップロードに使用できる文字列形式の列挙。

サイン:

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

タスクイベント

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

サイン:

export declare type TaskEvent = 'state_changed';

タスクの状態

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

サイン:

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

ストレージエラーコード

StorageErrorオブジェクトに付加できるエラー コード。

サイン:

export declare enum StorageErrorCode 

列挙メンバー

メンバー価値説明
APP_DELETED "app-deleted"
バケットが見つかりませんでした"bucket-not-found"
キャンセル"canceled"
CANNOT_SLICE_BLOB "cannot-slice-blob"
内部エラー"internal-error"
無効な引数"invalid-argument"
INVALID_ARGUMENT_COUNT "invalid-argument-count"
INVALID_CHECKSUM "invalid-checksum"
INVALID_DEFAULT_BUCKET "invalid-default-bucket"
INVALID_EVENT_NAME "invalid-event-name"
無効な形式"invalid-format"
INVALID_ROOT_OPERATION "invalid-root-operation"
無効なURL "invalid-url"
NO_DEFAULT_BUCKET "no-default-bucket"
NO_DOWNLOAD_URL "no-download-url"
OBJECT_NOT_FOUND "object-not-found"
プロジェクト_NOT_FOUND "project-not-found"
割り当て超過"quota-exceeded"
RETRY_LIMIT_EXCEEDED "retry-limit-exceeded"
SERVER_FILE_WRONG_SIZE "server-file-wrong-size"
未認証"unauthenticated"
無許可"unauthorized"
UNAUTHORIZED_APP "unauthorized-app"
未知"unknown"
UNSUPPORTED_ENVIRONMENT "unsupported-environment"