index.d.ts 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. /*! firebase-admin v12.1.1 */
  2. /*!
  3. * Copyright 2020 Google Inc.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License");
  6. * you may not use this file except in compliance with the License.
  7. * You may obtain a copy of the License at
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS,
  13. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. * See the License for the specific language governing permissions and
  15. * limitations under the License.
  16. */
  17. /**
  18. * Cloud Storage for Firebase.
  19. *
  20. * @packageDocumentation
  21. */
  22. import { File } from '@google-cloud/storage';
  23. import { App } from '../app';
  24. import { Storage } from './storage';
  25. export { Storage } from './storage';
  26. /**
  27. * Gets the {@link Storage} service for the default app or a given app.
  28. *
  29. * `getStorage()` can be called with no arguments to access the default
  30. * app's `Storage` service or as `getStorage(app)` to access the
  31. * `Storage` service associated with a specific app.
  32. *
  33. * @example
  34. * ```javascript
  35. * // Get the Storage service for the default app
  36. * const defaultStorage = getStorage();
  37. * ```
  38. *
  39. * @example
  40. * ```javascript
  41. * // Get the Storage service for a given app
  42. * const otherStorage = getStorage(otherApp);
  43. * ```
  44. */
  45. export declare function getStorage(app?: App): Storage;
  46. /**
  47. * Gets the download URL for the given {@link https://cloud.google.com/nodejs/docs/reference/storage/latest/storage/file | File}.
  48. *
  49. * @example
  50. * ```javascript
  51. * // Get the downloadUrl for a given file ref
  52. * const storage = getStorage();
  53. * const myRef = ref(storage, 'images/mountains.jpg');
  54. * const downloadUrl = await getDownloadURL(myRef);
  55. * ```
  56. */
  57. export declare function getDownloadURL(file: File): Promise<string>;