als-s3-methods

A Node.js module for simplified interaction with AWS S3. This module provides easy-to-use methods for common S3 operations like saving, retrieving, checking existence, removing, copying, and listing objects in an S3 bucket.

Installation

To install the module, use npm:

npm install als-s3-methods

Usage

First, require the module and initialize it with your AWS configuration and the S3 bucket name:

const s3Methods = require('als-s3-methods');
const { Bucket, awsConfig } = require('./path-to-your-config');

const { save, get, exists, remove, copy, list } = s3Methods(awsConfig, Bucket);

save

Saves an object to S3.

await save(Key, Body);

• Key: The key under which to store the object.
• Body: The data to save.

get

Retrieves an object from S3.

const object = await get(Key);

• Key: The key of the object to retrieve.

exists

Checks if an object exists in S3.

const doesExist = await exists(Key);

• Key: The key of the object to check.

remove

Removes one or more objects from S3.

const [removed,errors] = await remove(Key1, Key2, ...);

• Key1, Key2, ...: The keys of the objects to remove.

copy

Copies an object within the same S3 bucket.

await copy(SourceKey, DestinationKey);

• SourceKey: The key of the source object.
• DestinationKey: The key for the destination object.

list

Lists objects in S3 that start with the specified prefix.

const objects = await list(Prefix);

• Prefix: The prefix of the keys to list.

Examples

Below are some examples of how to use the module:

// Save an object
await save('example.txt', 'Hello, S3!');

// Get an object
const object = await get('example.txt');

// Check if an object exists
const doesExist = await exists('example.txt');

// Remove an object
await remove('example.txt');

// Copy an object
await copy('source.txt', 'destination.txt');

// List objects with a specific prefix
const objects = await list('folder/');