@apolitical/storage

Apolitical Storage

Node.js module to manipulate Apolitical's GCS (Google Cloud Storage) objects

Requirements

Requires the following to run:

• node.js 16.13.0+
• yarn

Installation

Install with yarn:

yarn add @apolitical/storage

Usage

First of all, include @apolitical/storage module:

const apoliticalStorage = require('@apolitical/storage');

The recommended way to use @apolitical/storage is to create your own storage instance with the appropriate parameters:

const opts = { bucketName: 'some-bucket-name' };
const storageInstance = apoliticalStorage(opts);

The download function

The download function allows you to download an object from GCS:

• It accepts the filePath parameter.
• It returns the fileBuffer object (Node.js Buffer class)

const fileBuffer = await storageInstance.download('some/file/path.jpg');

The upload function

The download function allows you to upload an object to GCS:

• It accepts the filePath and fileBuffer parameters.
• It returns the fileURL string.

const fileURL = await storageInstance.upload(''some/file/path.jpg', fileBuffer);