Flysystem-AWS

Flysystem-AWS is a plug-in for Flysystem, a file storage library for PHP. It allows developers to use Amazon Web Services (AWS) S3 buckets as a file system.

This module is also available in JavaScript.

Installation

In your project directory, run:

npm install flysystem-aws

Usage

To use the Flysystem-AWS module, you must first have an AWS account and an S3 bucket. Once you have these, you'll need to provide your AWS credentials and bucket information to the Flysystem-AWS module.

Here's an example of how to create a new S3 filesystem:

const AWS = require('aws-sdk');
const flysystem = require('flysystem');

const s3 = new AWS.S3({
  accessKeyId: 'YOUR_AWS_API_KEY',
  secretAccessKey: 'YOUR_AWS_API_SECRET',
});

const options = {
  s3,
  bucket: 'YOUR_BUCKET_NAME',
};

const filesystem = flysystem(new FlysystemAwsAdapter(options));

Once you've created your filesystem, you can use the Flysystem API to intereact with your S3 bucket:

// read a file from the S3 bucket
filesystem.read('/path/to/file.png');

// write a file to the S3 bucket
filesystem.write('/path/to/newFile.png', 'This is the contents of my new file!');

// check if a file exists
filesystem.has('/path/to/file.png');

// list contents of a directory
filesystem.listContents('/path/to/directory');

Conclusion

Flysystem-AWS is a powerful tool for developers who need to use AWS S3 buckets as a file system. With its easy-to-use API and rich features, it's a great choice for any project that involves working with AWS.