summaryrefslogtreecommitdiff
path: root/frontend-old/node_modules/@firebase/storage-compat/dist/src/reference.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'frontend-old/node_modules/@firebase/storage-compat/dist/src/reference.d.ts')
-rw-r--r--frontend-old/node_modules/@firebase/storage-compat/dist/src/reference.d.ts121
1 files changed, 121 insertions, 0 deletions
diff --git a/frontend-old/node_modules/@firebase/storage-compat/dist/src/reference.d.ts b/frontend-old/node_modules/@firebase/storage-compat/dist/src/reference.d.ts
new file mode 100644
index 0000000..20baac5
--- /dev/null
+++ b/frontend-old/node_modules/@firebase/storage-compat/dist/src/reference.d.ts
@@ -0,0 +1,121 @@
+/**
+ * @license
+ * Copyright 2020 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, StringFormat } from '@firebase/storage';
+import { StorageServiceCompat } from './service';
+import * as types from '@firebase/storage-types';
+import { Compat } from '@firebase/util';
+export declare class ReferenceCompat implements types.Reference, Compat<StorageReference> {
+ readonly _delegate: StorageReference;
+ storage: StorageServiceCompat;
+ constructor(_delegate: StorageReference, storage: StorageServiceCompat);
+ get name(): string;
+ get bucket(): string;
+ get fullPath(): string;
+ toString(): string;
+ /**
+ * @returns A reference to the object obtained by
+ * appending childPath, removing any duplicate, beginning, or trailing
+ * slashes.
+ */
+ child(childPath: string): types.Reference;
+ get root(): types.Reference;
+ /**
+ * @returns A reference to the parent of the
+ * current object, or null if the current object is the root.
+ */
+ get parent(): types.Reference | null;
+ /**
+ * Uploads a blob to this object's location.
+ * @param data - The blob to upload.
+ * @returns An UploadTask that lets you control and
+ * observe the upload.
+ */
+ put(data: Blob | Uint8Array | ArrayBuffer, metadata?: types.FullMetadata): types.UploadTask;
+ /**
+ * Uploads a string to this object's location.
+ * @param value - The string to upload.
+ * @param format - The format of the string to upload.
+ * @returns An UploadTask that lets you control and
+ * observe the upload.
+ */
+ putString(value: string, format?: StringFormat, metadata?: types.UploadMetadata): types.UploadTask;
+ /**
+ * List all items (files) and prefixes (folders) under this storage reference.
+ *
+ * This is a helper method for calling list() repeatedly until there are
+ * no more results. The default pagination size is 1000.
+ *
+ * Note: The results may not be consistent if objects are changed while this
+ * operation is running.
+ *
+ * Warning: listAll may potentially consume too many resources if there are
+ * too many results.
+ *
+ * @returns A Promise that resolves with all the items and prefixes under
+ * the current storage reference. `prefixes` contains references to
+ * sub-directories and `items` contains references to objects in this
+ * folder. `nextPageToken` is never returned.
+ */
+ listAll(): Promise<types.ListResult>;
+ /**
+ * List items (files) and prefixes (folders) under this storage reference.
+ *
+ * List API is only available for Firebase Rules Version 2.
+ *
+ * GCS is a key-blob store. Firebase Storage imposes the semantic of '/'
+ * delimited folder structure. Refer to GCS's List API if you want to learn more.
+ *
+ * To adhere to Firebase Rules's Semantics, Firebase Storage does not
+ * support objects whose paths end with "/" or contain two consecutive
+ * "/"s. Firebase Storage List API will filter these unsupported objects.
+ * list() may fail if there are too many unsupported objects in the bucket.
+ *
+ * @param options - See ListOptions for details.
+ * @returns A Promise that resolves with the items and prefixes.
+ * `prefixes` contains references to sub-folders and `items`
+ * contains references to objects in this folder. `nextPageToken`
+ * can be used to get the rest of the results.
+ */
+ list(options?: types.ListOptions | null): Promise<types.ListResult>;
+ /**
+ * A `Promise` that resolves with the metadata for this object. If this
+ * object doesn't exist or metadata cannot be retrieved, the promise is
+ * rejected.
+ */
+ getMetadata(): Promise<types.FullMetadata>;
+ /**
+ * Updates the metadata for this object.
+ * @param metadata - The new metadata for the object.
+ * Only values that have been explicitly set will be changed. Explicitly
+ * setting a value to null will remove the metadata.
+ * @returns A `Promise` that resolves
+ * with the new metadata for this object.
+ * @see firebaseStorage.Reference.prototype.getMetadata
+ */
+ updateMetadata(metadata: types.SettableMetadata): Promise<types.FullMetadata>;
+ /**
+ * @returns A `Promise` that resolves with the download
+ * URL for this object.
+ */
+ getDownloadURL(): Promise<string>;
+ /**
+ * Deletes the object at this location.
+ * @returns A `Promise` that resolves if the deletion succeeds.
+ */
+ delete(): Promise<void>;
+ private _throwIfRoot;
+}