48 lines
1.8 KiB
TypeScript
48 lines
1.8 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2021 Google LLC
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
import { StorageReference } from './public-types';
|
|
/**
|
|
* Downloads the data at the object's location. Returns an error if the object
|
|
* is not found.
|
|
*
|
|
* To use this functionality, you have to whitelist your app's origin in your
|
|
* Cloud Storage bucket. See also
|
|
* https://cloud.google.com/storage/docs/configuring-cors
|
|
*
|
|
* This API is not available in Node.
|
|
*
|
|
* @public
|
|
* @param ref - StorageReference where data should be downloaded.
|
|
* @param maxDownloadSizeBytes - If set, the maximum allowed size in bytes to
|
|
* retrieve.
|
|
* @returns A Promise that resolves with a Blob containing the object's bytes
|
|
*/
|
|
export declare function getBlob(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<Blob>;
|
|
/**
|
|
* Downloads the data at the object's location. Raises an error event if the
|
|
* object is not found.
|
|
*
|
|
* This API is only available in Node.
|
|
*
|
|
* @public
|
|
* @param ref - StorageReference where data should be downloaded.
|
|
* @param maxDownloadSizeBytes - If set, the maximum allowed size in bytes to
|
|
* retrieve.
|
|
* @returns A stream with the object's data as bytes
|
|
*/
|
|
export declare function getStream(ref: StorageReference, maxDownloadSizeBytes?: number): ReadableStream;
|