Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Fixed docgen for getDownloadURL #2241

Merged
merged 4 commits into from
Jul 11, 2023
Merged

Fixed docgen for getDownloadURL #2241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8099f47
Updated the comment
maneesht Jul 10, 2023
4278b68
Updated to use full uppercase
maneesht Jul 10, 2023
626e70d
Fixed tests
maneesht Jul 10, 2023
145093a
Fixed other tests
maneesht Jul 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion etc/firebase-admin.storage.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { Bucket } from '@google-cloud/storage';
import { File } from '@google-cloud/storage';

// @public
export function getDownloadUrl(file: File): Promise<string>;
export function getDownloadURL(file: File): Promise<string>;

// Warning: (ae-forgotten-export) The symbol "App" needs to be exported by the entry point index.d.ts
//
Expand Down
6 changes: 3 additions & 3 deletions src/storage/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,17 +61,17 @@ export function getStorage(app?: App): Storage {


/**
* Gets the download URL for the given {@link @google-cloud/storage#File}.
* Gets the download URL for the given {@link https://cloud.google.com/nodejs/docs/reference/storage/latest/storage/file | File}.
*
* @example
* ```javascript
* // Get the downloadUrl for a given file ref
* const storage = getStorage();
* const myRef = ref(storage, 'images/mountains.jpg');
* const downloadUrl = await getDownloadUrl(myRef);
* const downloadUrl = await getDownloadURL(myRef);
* ```
*/
export async function getDownloadUrl(file: File): Promise<string> {
export async function getDownloadURL(file: File): Promise<string> {
const endpoint =
(process.env.STORAGE_EMULATOR_HOST ||
'https://firebasestorage.googleapis.com') + '/v0';
Expand Down
6 changes: 3 additions & 3 deletions test/integration/storage.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import * as chaiAsPromised from 'chai-as-promised';
import { Bucket, File } from '@google-cloud/storage';

import { projectId } from './setup';
import { getDownloadUrl, getStorage } from '../../lib/storage/index';
import { getDownloadURL, getStorage } from '../../lib/storage/index';
import { getFirebaseMetadata } from '../../src/storage/utils';
import { FirebaseError } from '../../src/utils/error';

Expand Down Expand Up @@ -57,7 +57,7 @@ describe('admin.storage', () => {
currentRef
);
if (!metadata.downloadTokens) {
expect(getDownloadUrl(currentRef)).to.eventually.throw(
expect(getDownloadURL(currentRef)).to.eventually.throw(
new FirebaseError({
code: 'storage/invalid-argument',
message:
Expand All @@ -68,7 +68,7 @@ describe('admin.storage', () => {
);
return;
}
const downloadUrl = await getDownloadUrl(currentRef);
const downloadUrl = await getDownloadURL(currentRef);

const [token] = metadata.downloadTokens.split(',');
const storageEndpoint = `https://firebasestorage.googleapis.com/v0/b/${
Expand Down
10 changes: 5 additions & 5 deletions test/unit/storage/index.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import * as chaiAsPromised from 'chai-as-promised';
import * as mocks from '../../resources/mocks';
import { App } from '../../../src/app/index';
import * as StorageUtils from '../../../src/storage/utils';
import { getStorage, Storage, getDownloadUrl } from '../../../src/storage/index';
import { getStorage, Storage, getDownloadURL } from '../../../src/storage/index';

chai.should();
chai.use(sinonChai);
Expand Down Expand Up @@ -84,7 +84,7 @@ describe('Storage', () => {
.returns(Promise.resolve({} as StorageUtils.FirebaseMetadata));
const storage1 = getStorage(mockApp);
const fileRef = storage1.bucket('gs://mock').file('abc');
await expect(getDownloadUrl(fileRef)).to.be.rejectedWith(
await expect(getDownloadURL(fileRef)).to.be.rejectedWith(
'No download token available. Please create one in the Firebase Console.'
);
});
Expand All @@ -96,7 +96,7 @@ describe('Storage', () => {
.returns(Promise.reject(error));
const storage1 = getStorage(mockApp);
const fileRef = storage1.bucket('gs://mock').file('abc');
await expect(getDownloadUrl(fileRef)).to.be.rejectedWith(
await expect(getDownloadURL(fileRef)).to.be.rejectedWith(
error
);
});
Expand All @@ -111,7 +111,7 @@ describe('Storage', () => {
);
const storage1 = getStorage(mockApp);
const fileRef = storage1.bucket('gs://mock').file('abc');
await expect(getDownloadUrl(fileRef)).to.eventually.eq(
await expect(getDownloadURL(fileRef)).to.eventually.eq(
`https://firebasestorage.googleapis.com/v0/b/${fileRef.bucket.name}/o/${encodeURIComponent(fileRef.name)}?alt=media&token=${downloadTokens[0]}`
);
});
Expand All @@ -136,7 +136,7 @@ describe('Storage', () => {
// Need to create a new mock app to force `getStorage`'s checking of env vars.
const storage1 = getStorage(mocks.app(envName));
const fileRef = storage1.bucket('gs://mock').file('abc');
await expect(getDownloadUrl(fileRef)).to.eventually.eq(
await expect(getDownloadURL(fileRef)).to.eventually.eq(
`http://${HOST}/v0/b/${fileRef.bucket.name}/o/${encodeURIComponent(
fileRef.name
)}?alt=media&token=${downloadTokens[0]}`
Expand Down