Storage class
Stay organized with collections
Save and categorize content based on your preferences.
The default Storage service if no app is provided or the Storage service associated with the provided app.
Signature:
export declare class Storage
Properties
| Property |
Modifiers |
Type |
Description |
| app |
|
App |
Optional app whose Storage service to return. If not provided, the default Storage service will be returned. |
Methods
| Method |
Modifiers |
Description |
| bucket(name) |
|
Gets a reference to a Cloud Storage bucket. |
Storage.app
Optional app whose Storage service to return. If not provided, the default Storage service will be returned.
Signature:
get app(): App;
Storage.bucket()
Gets a reference to a Cloud Storage bucket.
Signature:
bucket(name?: string): Bucket;
Parameters
| Parameter |
Type |
Description |
| name |
string |
Optional name of the bucket to be retrieved. If name is not specified, retrieves a reference to the default bucket. |
Returns:
Bucket
A Bucket instance as defined in the @google-cloud/storage package.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-07-29 UTC.
[null,null,["Last updated 2022-07-29 UTC."],[],[],null,["# Storage class\n\nThe default `Storage` service if no app is provided or the `Storage` service associated with the provided app.\n\n**Signature:** \n\n export declare class Storage \n\nProperties\n----------\n\n| Property | Modifiers | Type | Description |\n|-------------------------------------------------------|-----------|------|------------------------------------------------------------------------------------------------------------------|\n| [app](./firebase-admin.storage.storage.md#storageapp) | | App | Optional app whose `Storage` service to return. If not provided, the default `Storage` service will be returned. |\n\nMethods\n-------\n\n| Method | Modifiers | Description |\n|-------------------------------------------------------------------|-----------|---------------------------------------------|\n| [bucket(name)](./firebase-admin.storage.storage.md#storagebucket) | | Gets a reference to a Cloud Storage bucket. |\n\nStorage.app\n-----------\n\nOptional app whose `Storage` service to return. If not provided, the default `Storage` service will be returned.\n\n**Signature:** \n\n get app(): App;\n\nStorage.bucket()\n----------------\n\nGets a reference to a Cloud Storage bucket.\n\n**Signature:** \n\n bucket(name?: string): Bucket;\n\n### Parameters\n\n| Parameter | Type | Description |\n|-----------|--------|---------------------------------------------------------------------------------------------------------------------|\n| name | string | Optional name of the bucket to be retrieved. If name is not specified, retrieves a reference to the default bucket. |\n\n**Returns:**\n\nBucket\n\nA [Bucket](https://cloud.google.com/nodejs/docs/reference/storage/latest/Bucket) instance as defined in the `@google-cloud/storage` package."]]
