Generate storage snippets

Author: samtstern

snippets/storage-next/create-reference/storage_create_ref.js

@@ -0,0 +1,14 @@
+// This snippet file was generated by processing the source file:
+// ./storage-next/create-reference.js
+//
+// To make edits to the snippets in this file, please edit the source
+
+// [START storage_create_ref_modular]
+import { getStorage, ref } from "firebase/storage";
+
+// Get a reference to the storage service, which is used to create references in your storage bucket
+const storage = getStorage(firebaseApp);
+
+// Create a storage reference from our storage service
+const storageRef = ref(storage);
+// [END storage_create_ref_modular]

snippets/storage-next/create-reference/storage_create_ref_child.js

@@ -0,0 +1,19 @@
+// This snippet file was generated by processing the source file:
+// ./storage-next/create-reference.js
+//
+// To make edits to the snippets in this file, please edit the source
+
+// [START storage_create_ref_child_modular]
+import { getStorage, ref } from "firebase/storage";
+
+const storage = getStorage(firebaseApp);
+
+// Create a child reference
+const imagesRef = ref(storage, 'images');
+// imagesRef now points to 'images'
+
+// Child references can also take paths delimited by '/'
+const spaceRef = ref(storage, 'images/space.jpg');
+// spaceRef now points to "images/space.jpg"
+// imagesRef still points to "images"
+// [END storage_create_ref_child_modular]

snippets/storage-next/create-reference/storage_navigate_ref.js

@@ -0,0 +1,19 @@
+// This snippet file was generated by processing the source file:
+// ./storage-next/create-reference.js
+//
+// To make edits to the snippets in this file, please edit the source
+
+// [START storage_navigate_ref_modular]
+import { getStorage, ref } from "firebase/storage";
+
+const storage = getStorage(firebaseApp);
+const spaceRef = ref(storage, 'images/space.jpg');
+
+// Parent allows us to move to the parent of a reference
+const imagesRef = spaceRef.parent;
+// imagesRef now points to 'images'
+
+// Root allows us to move all the way back to the top of our bucket
+const rootRef = spaceRef.root;
+// rootRef now points to the root
+// [END storage_navigate_ref_modular]

snippets/storage-next/create-reference/storage_navigate_ref_chain.js

@@ -0,0 +1,18 @@
+// This snippet file was generated by processing the source file:
+// ./storage-next/create-reference.js
+//
+// To make edits to the snippets in this file, please edit the source
+
+// [START storage_navigate_ref_chain_modular]
+import { getStorage, ref } from "firebase/storage";
+
+const storage = getStorage(firebaseApp);
+const spaceRef = ref(storage, 'images/space.jpg');
+
+// References can be chained together multiple times
+const earthRef = ref(spaceRef.parent, 'earth.jpg');
+// earthRef points to 'images/earth.jpg'
+
+// nullRef is null, since the parent of root is null
+const nullRef = spaceRef.root.parent;
+// [END storage_navigate_ref_chain_modular]

snippets/storage-next/create-reference/storage_ref_full_example.js

@@ -0,0 +1,30 @@
+// This snippet file was generated by processing the source file:
+// ./storage-next/create-reference.js
+//
+// To make edits to the snippets in this file, please edit the source
+
+// [START storage_ref_full_example_modular]
+import { getStorage, ref } from "firebase/storage";
+
+const storage = getStorage(firebaseApp);
+
+// Points to the root reference
+const storageRef = ref(storage);
+
+// Points to 'images'
+const imagesRef = ref(storageRef, 'images');
+
+// Points to 'images/space.jpg'
+// Note that you can use variables to create child values
+const fileName = 'space.jpg';
+const spaceRef = ref(imagesRef, fileName);
+
+// File path is 'images/space.jpg'
+const path = spaceRef.fullPath;
+
+// File name is 'space.jpg'
+const name = spaceRef.name;
+
+// Points to 'images'
+const imagesRefAgain = spaceRef.parent;
+// [END storage_ref_full_example_modular]

snippets/storage-next/create-reference/storage_ref_properties.js

@@ -0,0 +1,22 @@
+// This snippet file was generated by processing the source file:
+// ./storage-next/create-reference.js
+//
+// To make edits to the snippets in this file, please edit the source
+
+// [START storage_ref_properties_modular]
+import { getStorage, ref } from "firebase/storage";
+
+const storage = getStorage(firebaseApp);
+const spaceRef = ref(storage, 'images/space.jpg');
+
+// Reference's path is: 'images/space.jpg'
+// This is analogous to a file path on disk
+spaceRef.fullPath;
+
+// Reference's name is the last segment of the full path: 'space.jpg'
+// This is analogous to the file name
+spaceRef.name;
+
+// Reference's bucket is the name of the storage bucket where files are stored
+spaceRef.bucket;
+// [END storage_ref_properties_modular]

snippets/storage-next/delete-files/storage_delete_file.js

@@ -0,0 +1,20 @@
+// This snippet file was generated by processing the source file:
+// ./storage-next/delete-files.js
+//
+// To make edits to the snippets in this file, please edit the source
+
+// [START storage_delete_file_modular]
+import { getStorage, ref, deleteObject } from "firebase/storage";
+
+const storage = getStorage(firebaseApp);
+
+// Create a reference to the file to delete
+const desertRef = ref(storage, 'images/desert.jpg');
+
+// Delete the file
+deleteObject(desertRef).then(() => {
+  // File deleted successfully
+}).catch((error) => {
+  // Uh-oh, an error occurred!
+});
+// [END storage_delete_file_modular]

snippets/storage-next/download-files/storage_download_create_ref.js

@@ -0,0 +1,19 @@
+// This snippet file was generated by processing the source file:
+// ./storage-next/download-files.js
+//
+// To make edits to the snippets in this file, please edit the source
+
+// [START storage_download_create_ref_modular]
+import { getStorage, ref } from "firebase/storage";
+
+// Create a reference with an initial file path and name
+const storage = getStorage(firebaseApp);
+const pathReference = ref(storage, 'images/stars.jpg');
+
+// Create a reference from a Google Cloud Storage URI
+const gsReference = ref(storage, 'gs://bucket/images/stars.jpg');
+
+// Create a reference from an HTTPS URL
+// Note that in the URL, characters are URL escaped!
+const httpsReference = ref(storage, 'https://firebasestorage.googleapis.com/b/bucket/o/images%20stars.jpg');  
+// [END storage_download_create_ref_modular]

snippets/storage-next/download-files/storage_download_full_example.js

@@ -0,0 +1,39 @@
+// This snippet file was generated by processing the source file:
+// ./storage-next/download-files.js
+//
+// To make edits to the snippets in this file, please edit the source
+
+// [START storage_download_full_example_modular]
+import { getStorage, ref, getDownloadURL } from "firebase/storage";
+
+// Create a reference to the file we want to download
+const storage = getStorage(firebaseApp);
+const starsRef = ref(storage, 'images/stars.jpg');
+
+// Get the download URL
+getDownloadURL(starsRef)
+  .then((url) => {
+    // Insert url into an <img> tag to "download"
+  })
+  .catch((error) => {
+    // A full list of error codes is available at
+    // https://firebase.google.com/docs/storage/web/handle-errors
+    switch (error.code) {
+      case 'storage/object-not-found':
+        // File doesn't exist
+        break;
+      case 'storage/unauthorized':
+        // User doesn't have permission to access the object
+        break;
+      case 'storage/canceled':
+        // User canceled the upload
+        break;
+
+      // ...
+
+      case 'storage/unknown':
+        // Unknown error occurred, inspect the server response
+        break;
+    }
+  });
+// [END storage_download_full_example_modular]

snippets/storage-next/download-files/storage_download_via_url.js

@@ -0,0 +1,30 @@
+// This snippet file was generated by processing the source file:
+// ./storage-next/download-files.js
+//
+// To make edits to the snippets in this file, please edit the source
+
+// [START storage_download_via_url_modular]
+import { getStorage, ref, getDownloadURL } from "firebase/storage";
+
+const storage = getStorage(firebaseApp);
+getDownloadURL(ref(storage, 'images/stars.jpg'))
+  .then((url) => {
+    // `url` is the download URL for 'images/stars.jpg'
+
+    // This can be downloaded directly:
+    const xhr = new XMLHttpRequest();
+    xhr.responseType = 'blob';
+    xhr.onload = (event) => {
+      const blob = xhr.response;
+    };
+    xhr.open('GET', url);
+    xhr.send();
+
+    // Or inserted into an <img> element
+    const img = document.getElementById('myimg');
+    img.setAttribute('src', url);
+  })
+  .catch((error) => {
+    // Handle any errors
+  });
+// [END storage_download_via_url_modular]

snippets/storage-next/file-metadata/storage_custom_metadata.js

@@ -0,0 +1,13 @@
+// This snippet file was generated by processing the source file:
+// ./storage-next/file-metadata.js
+//
+// To make edits to the snippets in this file, please edit the source
+
+// [START storage_custom_metadata_modular]
+const metadata = {
+  customMetadata: {
+    'location': 'Yosemite, CA, USA',
+    'activity': 'Hiking'
+  }
+};
+// [END storage_custom_metadata_modular]

snippets/storage-next/file-metadata/storage_delete_metadata.js

@@ -0,0 +1,24 @@
+// This snippet file was generated by processing the source file:
+// ./storage-next/file-metadata.js
+//
+// To make edits to the snippets in this file, please edit the source
+
+// [START storage_delete_metadata_modular]
+import { getStorage, ref, updateMetadata } from "firebase/storage";
+
+const storage = getStorage(firebaseApp);
+const forestRef = ref(storage, 'images/forest.jpg');
+
+// Create file metadata with property to delete
+const deleteMetadata = {
+  contentType: null
+};
+
+// Delete the metadata property
+updateMetadata(forestRef, deleteMetadata)
+  .then((metadata) => {
+    // metadata.contentType should be null
+  }).catch((error) => {
+    // Uh-oh, an error occurred!
+  });
+// [END storage_delete_metadata_modular]

snippets/storage-next/file-metadata/storage_get_metadata.js

@@ -0,0 +1,21 @@
+// This snippet file was generated by processing the source file:
+// ./storage-next/file-metadata.js
+//
+// To make edits to the snippets in this file, please edit the source
+
+// [START storage_get_metadata_modular]
+import { getStorage, ref, getMetadata } from "firebase/storage";
+
+// Create a reference to the file whose metadata we want to retrieve
+const storage = getStorage(firebaseApp);
+const forestRef = ref(storage, 'images/forest.jpg');
+
+// Get metadata properties
+getMetadata(forestRef)
+  .then((metadata) => {
+    // Metadata now contains the metadata for 'images/forest.jpg'
+  })
+  .catch((error) => {
+    // Uh-oh, an error occurred!
+  });
+// [END storage_get_metadata_modular]

snippets/storage-next/file-metadata/storage_update_metadata.js

@@ -0,0 +1,26 @@
+// This snippet file was generated by processing the source file:
+// ./storage-next/file-metadata.js
+//
+// To make edits to the snippets in this file, please edit the source
+
+// [START storage_update_metadata_modular]
+import { getStorage, ref, updateMetadata } from "firebase/storage";
+
+// Create a reference to the file whose metadata we want to change
+const storage = getStorage(firebaseApp);
+const forestRef = ref(storage, 'images/forest.jpg');
+
+// Create file metadata to update
+const newMetadata = {
+  cacheControl: 'public,max-age=300',
+  contentType: 'image/jpeg'
+};
+
+// Update metadata properties
+updateMetadata(forestRef, newMetadata)
+  .then((metadata) => {
+    // Updated metadata for 'images/forest.jpg' is returned in the Promise
+  }).catch((error) => {
+    // Uh-oh, an error occurred!
+  });
+// [END storage_update_metadata_modular]

snippets/storage-next/index/storage_custom_app.js

@@ -0,0 +1,8 @@
+// This snippet file was generated by processing the source file:
+// ./storage-next/index.js
+//
+// To make edits to the snippets in this file, please edit the source
+
+// [START storage_custom_app_modular]
+// TODO: Snippet not yet written...
+// [END storage_custom_app_modular]

snippets/storage-next/index/storage_initialize.js

@@ -0,0 +1,22 @@
+// This snippet file was generated by processing the source file:
+// ./storage-next/index.js
+//
+// To make edits to the snippets in this file, please edit the source
+
+// [START storage_initialize_modular]
+import { initializeApp } from "firebase/app";
+import { getStorage, uploadBytesResumable } from "firebase/storage";
+
+// Set the configuration for your app
+// TODO: Replace with your app's config object
+const firebaseConfig = {
+  apiKey: '<your-api-key>',
+  authDomain: '<your-auth-domain>',
+  databaseURL: '<your-database-url>',
+  storageBucket: '<your-storage-bucket-url>'
+};
+const firebaseApp = initializeApp(firebaseConfig);
+
+// Get a reference to the storage service, which is used to create references in your storage bucket
+const storage = getStorage(firebaseApp);
+// [END storage_initialize_modular]

snippets/storage-next/index/storage_multiple_buckets.js

@@ -0,0 +1,8 @@
+// This snippet file was generated by processing the source file:
+// ./storage-next/index.js
+//
+// To make edits to the snippets in this file, please edit the source
+
+// [START storage_multiple_buckets_modular]
+// TODO: Snippet not yet written...
+// [END storage_multiple_buckets_modular]