storage.d.ts 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. /*! firebase-admin v12.1.1 */
  2. /*!
  3. * @license
  4. * Copyright 2017 Google Inc.
  5. *
  6. * Licensed under the Apache License, Version 2.0 (the "License");
  7. * you may not use this file except in compliance with the License.
  8. * You may obtain a copy of the License at
  9. *
  10. * http://www.apache.org/licenses/LICENSE-2.0
  11. *
  12. * Unless required by applicable law or agreed to in writing, software
  13. * distributed under the License is distributed on an "AS IS" BASIS,
  14. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15. * See the License for the specific language governing permissions and
  16. * limitations under the License.
  17. */
  18. import { App } from '../app';
  19. import { Bucket } from '@google-cloud/storage';
  20. /**
  21. * The default `Storage` service if no
  22. * app is provided or the `Storage` service associated with the provided
  23. * app.
  24. */
  25. export declare class Storage {
  26. private readonly appInternal;
  27. private readonly storageClient;
  28. /**
  29. * Gets a reference to a Cloud Storage bucket.
  30. *
  31. * @param name - Optional name of the bucket to be retrieved. If name is not specified,
  32. * retrieves a reference to the default bucket.
  33. * @returns A {@link https://cloud.google.com/nodejs/docs/reference/storage/latest/Bucket | Bucket}
  34. * instance as defined in the `@google-cloud/storage` package.
  35. */
  36. bucket(name?: string): Bucket;
  37. /**
  38. * Optional app whose `Storage` service to
  39. * return. If not provided, the default `Storage` service will be returned.
  40. */
  41. get app(): App;
  42. }