From 8dea8881e0da125ed766b69bdb633e7d5259692a Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Wed, 3 Feb 2021 12:15:28 -0800 Subject: [PATCH] Fill out storage bucket url param --- common/api-review/storage.api.md | 4 ++-- packages/storage/exp/index.ts | 11 +++++++++-- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/common/api-review/storage.api.md b/common/api-review/storage.api.md index 3296233f0c2..b80645b8581 100644 --- a/common/api-review/storage.api.md +++ b/common/api-review/storage.api.md @@ -4,7 +4,7 @@ ```ts -import { FirebaseApp } from '@firebase/app'; +import { FirebaseApp } from '@firebase/app-types'; import { FirebaseStorageError } from '@firebase/storage-types/exp'; import { FullMetadata } from '@firebase/storage-types/exp'; import { ListOptions } from '@firebase/storage-types/exp'; @@ -33,7 +33,7 @@ export function getDownloadURL(ref: StorageReference): Promise; export function getMetadata(ref: StorageReference): Promise; // @public -export function getStorage(app: FirebaseApp, url?: string): StorageService; +export function getStorage(app: FirebaseApp, bucketUrl?: string): StorageService; // @public export function list(ref: StorageReference, options?: ListOptions): Promise; diff --git a/packages/storage/exp/index.ts b/packages/storage/exp/index.ts index 253e366370f..69f63d47439 100644 --- a/packages/storage/exp/index.ts +++ b/packages/storage/exp/index.ts @@ -294,15 +294,22 @@ const STORAGE_TYPE = 'storage-exp'; * Gets a Firebase StorageService instance for the given Firebase app. * @public * @param app - Firebase app to get Storage instance for. + * @param bucketUrl - The gs:// url to your Firebase Storage Bucket. + * If not passed, uses the app's default Storage Bucket. * @returns A Firebase StorageService instance. */ -export function getStorage(app: FirebaseApp, url?: string): StorageService { +export function getStorage( + app: FirebaseApp, + bucketUrl?: string +): StorageService { // Dependencies const storageProvider: Provider<'storage-exp'> = _getProvider( app, STORAGE_TYPE ); - const storageInstance = storageProvider.getImmediate({ identifier: url }); + const storageInstance = storageProvider.getImmediate({ + identifier: bucketUrl + }); return storageInstance; }