Skip to content

Commit a42a35e

Browse files
authored
Fill out storage bucket url param (#4410)
1 parent a5ac818 commit a42a35e

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

common/api-review/storage.api.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
55
```ts
66

7-
import { FirebaseApp } from '@firebase/app';
7+
import { FirebaseApp } from '@firebase/app-types';
88
import { FirebaseStorageError } from '@firebase/storage-types/exp';
99
import { FullMetadata } from '@firebase/storage-types/exp';
1010
import { ListOptions } from '@firebase/storage-types/exp';
@@ -33,7 +33,7 @@ export function getDownloadURL(ref: StorageReference): Promise<string>;
3333
export function getMetadata(ref: StorageReference): Promise<FullMetadata>;
3434

3535
// @public
36-
export function getStorage(app: FirebaseApp, url?: string): StorageService;
36+
export function getStorage(app: FirebaseApp, bucketUrl?: string): StorageService;
3737

3838
// @public
3939
export function list(ref: StorageReference, options?: ListOptions): Promise<ListResult>;

packages/storage/exp/index.ts

+9-2
Original file line numberDiff line numberDiff line change
@@ -294,15 +294,22 @@ const STORAGE_TYPE = 'storage-exp';
294294
* Gets a Firebase StorageService instance for the given Firebase app.
295295
* @public
296296
* @param app - Firebase app to get Storage instance for.
297+
* @param bucketUrl - The gs:// url to your Firebase Storage Bucket.
298+
* If not passed, uses the app's default Storage Bucket.
297299
* @returns A Firebase StorageService instance.
298300
*/
299-
export function getStorage(app: FirebaseApp, url?: string): StorageService {
301+
export function getStorage(
302+
app: FirebaseApp,
303+
bucketUrl?: string
304+
): StorageService {
300305
// Dependencies
301306
const storageProvider: Provider<'storage-exp'> = _getProvider(
302307
app,
303308
STORAGE_TYPE
304309
);
305-
const storageInstance = storageProvider.getImmediate({ identifier: url });
310+
const storageInstance = storageProvider.getImmediate({
311+
identifier: bucketUrl
312+
});
306313
return storageInstance;
307314
}
308315

0 commit comments

Comments
 (0)