What is @google-cloud/storage?
The @google-cloud/storage npm package is a client library for using Google Cloud Storage, which is a service for storing and accessing data on Google's infrastructure. The package allows Node.js developers to interact with Google Cloud Storage in a server-side application.
What are @google-cloud/storage's main functionalities?
Uploading files
This feature allows users to upload files to a Google Cloud Storage bucket. The code sample demonstrates how to upload a local file to a specified bucket.
const { Storage } = require('@google-cloud/storage');
const storage = new Storage();
async function uploadFile() {
await storage.bucket('my-bucket').upload('local-file-path', {
destination: 'destination-file-path',
});
console.log('File uploaded.');
}
uploadFile().catch(console.error);
Downloading files
This feature enables users to download files from a Google Cloud Storage bucket. The code sample shows how to download a file from a bucket to the local file system.
const { Storage } = require('@google-cloud/storage');
const storage = new Storage();
async function downloadFile() {
const options = {
destination: 'local-file-path',
};
await storage.bucket('my-bucket').file('remote-file-path').download(options);
console.log('File downloaded.');
}
downloadFile().catch(console.error);
Listing files
This feature provides the ability to list all files in a Google Cloud Storage bucket. The code sample lists the names of all files in a specified bucket.
const { Storage } = require('@google-cloud/storage');
const storage = new Storage();
async function listFiles() {
const [files] = await storage.bucket('my-bucket').getFiles();
files.forEach(file => console.log(file.name));
}
listFiles().catch(console.error);
Deleting files
This feature allows users to delete files from a Google Cloud Storage bucket. The code sample demonstrates how to delete a specific file from a bucket.
const { Storage } = require('@google-cloud/storage');
const storage = new Storage();
async function deleteFile() {
await storage.bucket('my-bucket').file('file-to-delete').delete();
console.log('File deleted.');
}
deleteFile().catch(console.error);
Managing buckets
This feature enables users to manage buckets, including creating and deleting buckets. The code sample shows how to create a new bucket in Google Cloud Storage.
const { Storage } = require('@google-cloud/storage');
const storage = new Storage();
async function createBucket() {
await storage.createBucket('new-bucket');
console.log('Bucket created.');
}
createBucket().catch(console.error);
Other packages similar to @google-cloud/storage
aws-sdk
The aws-sdk package is a client library for Amazon Web Services (AWS), including Amazon S3, which is a similar object storage service to Google Cloud Storage. It provides a wide range of functionalities to interact with various AWS services.
azure-storage
The azure-storage package is a client library for Microsoft Azure Storage. Like Google Cloud Storage, Azure Storage offers blob storage for unstructured data, and this package allows Node.js developers to work with Azure blobs, files, queues, and tables.
pkgcloud
The pkgcloud package is a multi-cloud provisioning library for Node.js that abstracts away differences among multiple cloud providers. It supports various cloud services, including storage services like Amazon S3 and Rackspace Cloud Files, and can be used as an alternative to provider-specific packages like @google-cloud/storage.