storage-namespace.d.ts 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. /*! firebase-admin v12.1.1 */
  2. /*!
  3. * Copyright 2021 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. import { App } from '../app';
  18. import { Storage as TStorage } from './storage';
  19. /**
  20. * Gets the {@link firebase-admin.storage#Storage} service for the
  21. * default app or a given app.
  22. *
  23. * `admin.storage()` can be called with no arguments to access the default
  24. * app's `Storage` service or as `admin.storage(app)` to access the
  25. * `Storage` service associated with a specific app.
  26. *
  27. * @example
  28. * ```javascript
  29. * // Get the Storage service for the default app
  30. * var defaultStorage = admin.storage();
  31. * ```
  32. *
  33. * @example
  34. * ```javascript
  35. * // Get the Storage service for a given app
  36. * var otherStorage = admin.storage(otherApp);
  37. * ```
  38. */
  39. export declare function storage(app?: App): storage.Storage;
  40. export declare namespace storage {
  41. /**
  42. * Type alias to {@link firebase-admin.storage#Storage}.
  43. */
  44. type Storage = TStorage;
  45. }