Skip to content

Fill out storage bucket url param #4410

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 3, 2021
Merged

Fill out storage bucket url param #4410

merged 1 commit into from
Feb 3, 2021

Conversation

hsubox76
Copy link
Contributor

@hsubox76 hsubox76 commented Feb 3, 2021

Add jsdoc description and change name from url to bucketUrl to make it more clear. (FYI the param name in the original API is url).

Fixes #4407

@changeset-bot
Copy link

changeset-bot bot commented Feb 3, 2021

⚠️ No Changeset found

Latest commit: 8dea888

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@google-oss-bot
Copy link
Contributor

Binary Size Report

Affected SDKs

  • @firebase/storage/exp

    Type Base (fd16bb2) Head (e7dfb01) Diff
    browser 49.1 kB 49.2 kB +12 B (+0.0%)
    main 49.9 kB 49.9 kB +12 B (+0.0%)
    module 49.1 kB 49.2 kB +12 B (+0.0%)

Test Logs

@google-oss-bot
Copy link
Contributor

Size Analysis Report

Affected Products

No changes between base commit (fd16bb2) and head commit (e7dfb01).

@samtstern
Copy link
Contributor

samtstern commented Feb 3, 2021

@hsubox76 to be clear this is what I see in my types today:

/**
 * Gets a Firebase StorageService instance for the given Firebase app.
 * @public
 * @param app - Firebase app to get Storage instance for.
 * @returns A Firebase StorageService instance.
 */
export declare function getStorage(app: FirebaseApp): StorageService;

So in #4407 I wasn't saying that the url parameter wasn't clear, I was saying that I don't have it at all. Let me see if I can remove node_modules and see if maybe I missed an update to exp


Edit: this changed between 0.900.10 and 0.900.11, I see the better types now:

/**
 * Gets a Firebase StorageService instance for the given Firebase app.
 * @public
 * @param app - Firebase app to get Storage instance for.
 * @returns A Firebase StorageService instance.
 */
export declare function getStorage(app: FirebaseApp, url?: string): StorageService;

This change LGTM anyway! Definitely clearer.

export function getStorage(app: FirebaseApp, url?: string): StorageService {
export function getStorage(
app: FirebaseApp,
bucketUrl?: string
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

gsUrl?

Feel free to keep as is.

@hsubox76 hsubox76 merged commit a42a35e into master Feb 3, 2021
@hsubox76 hsubox76 deleted the storage-bucket-type branch February 3, 2021 22:07
@firebase firebase locked and limited conversation to collaborators Mar 6, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Storage SDK missing methods to reference multiple buckets
5 participants