rocketmakers-storage-gcs - Google cloud storage

This package facilitates interaction with Google Cloud Storage. The package includes a GcsStorage class that implements the IStorage interface, providing a seamless way to perform various operations on files stored in Google Cloud Storage. The class supports functionalities such as copying, deleting, reading, and creating files, making it a powerful tool for managing your storage needs.

• rocketmakers-storage
  • Installation
  • Usage

Installation

To use this package, install it via npm:

npm install @rocketmakers/storage-gcs

yarn add @rocketmakers/storage-gcs

pnpm add @rocketmakers/storage-gcs

Usage

Below is an example of how to use the GcsStorage class in your application:

import { GcsStorage, IGcsConfig, IGcsStorageConfig } from '@rocketmakers/storage-gcs';

// Configuration for Google Cloud Storage
const gcsConfig: IGcsConfig = {
  projectId: 'your-project-id',
  credentials: {
    client_email: 'your-client-email',
    private_key: 'your-private-key',
  },
};

// Storage configuration
const storageConfig: IGcsStorageConfig = {
  gcs: gcsConfig,
  bucketName: 'your-bucket-name',
};

// Create an instance of GcsStorage
const gcsStorage = new GcsStorage(storageConfig);

// Example: Validate storage
const validationResult = await gcsStorage.validate();
console.log('Storage validation result:', validationResult);

// Example: Copy a file
const fromFilePath = 'path/to/source/file.txt';
const toFilePath = 'path/to/destination/file.txt';
const copyResult = await gcsStorage.fileCopy(fromFilePath, toFilePath);
console.log('File copy result:', copyResult);

// ... Other operations (delete, read, create, etc.)