LWGoogleStorage

A simple package for interacting with Google Cloud Storage (GCS) to upload, download, delete files, and generate signed URLs. The package is designed to interact with Google Cloud Storage in a Node.js environment.

Installation

You can install the package using npm:

npm install lw-google-storage

Usage

Initialize LWGoogleStorage

To use the package, you need to initialize the LWGoogleStorage class by providing the necessary parameters like projectId, keyFilename, and bucketName.

const LWGoogleStorage = require("lw-google-storage");

const storage = new LWGoogleStorage({
  projectId: "your-google-cloud-project-id",
  keyFilename: "path/to/your/service/account/key.json",
  bucketName: "your-bucket-name",
});

Upload a File

You can upload a file to Google Cloud Storage using the uploadFile method.

storage
  .uploadFile("path/to/your/local/file.txt", "destinationFileName.txt")
  .then((response) => {
    console.log("File uploaded successfully");
  })
  .catch((error) => {
    console.error("Error uploading file:", error);
  });

Download a File

You can download a file from Google Cloud Storage using the downloadFile method.

storage
  .downloadFile("destinationFileName.txt")
  .then((fileContent) => {
    console.log("File downloaded successfully:", fileContent);
  })
  .catch((error) => {
    console.error("Error downloading file:", error);
  });

Share a Signed URL

You can generate a signed URL for a file with an expiration time.

storage
  .shareUrl("destinationFileName.txt", 15)
  .then((url) => {
    console.log("Signed URL:", url);
  })
  .catch((error) => {
    console.error("Error generating signed URL:", error);
  });

Delete a File

You can delete a file from Google Cloud Storage.

storage
  .deleteFile("destinationFileName.txt")
  .then((response) => {
    console.log("File deleted successfully");
  })
  .catch((error) => {
    console.error("Error deleting file:", error);
  });

Get File URL

You can retrieve a public/private URL for a file in the bucket.

storage
  .getFile("destinationFileName.txt", isPrivate)
  .then((url) => {
    console.log("File URL:", url);
  })
  .catch((error) => {
    console.error("Error getting file URL:", error);
  });

Methods

• uploadFile(filePath, destFileName) - Upload a file to Google Cloud Storage.
• downloadFile(destFileName) - Download a file from Google Cloud Storage.
• shareUrl(destFileName, expirationInMinutes) - Generate a signed URL for a file.
• deleteFile(destFileName) - Delete a file from Google Cloud Storage.
• getFile(destFileName, isPrivate) - Get the public/private URL of a file.

Requirements

• Node.js v12 or higher
• Google Cloud Storage Account
• Google Cloud Service Account Key

License

MIT License. See LICENSE for details.