@mskii/s3-manager

@mskii/s3-manager

@mskii/s3-manager は、AWS S3 オブジェクトを簡単かつ効率的に操作するための Node.js モジュールです。このモジュールを使用することで、S3 バケット内のファイルのアップロード、ダウンロード、削除、およびその他の操作を行うことができます。

特徴

• ファイルのアップロードとダウンロード
• ディレクトリの一括アップロードとダウンロード
• ファイルの存在確認
• ファイルサイズの取得
• S3 ディレクトリ内のファイルリストの取得
• etc.

インストール

npm install @mskii/s3-manager

使い方

下記は一部の機能の一例です。
その他の機能については source を確認してください。

基本的なセットアップ

const S3Manager = require('@mskii/s3-manager');
const s3 = await S3Manager.create({ configFilePath: './config.json' });

ファイルのアップロード

s3Manager.putS3File('path/to/local/file.txt', 'path/to/s3/file.txt')
  .then(() => {
    console.log('ファイルのアップロードに成功');
  })
  .catch(err => {
    console.error('ファイルのアップロードエラー:', err);
  });

ファイルのダウンロード

s3Manager.getS3File('path/to/s3/file.txt', 'path/to/local/file.txt')
  .then(() => {
    console.log('ファイルのダウンロードに成功');
  })
  .catch(err => {
    console.error('ファイルのダウンロードエラー:', err);
  });

ファイルの存在確認

s3Manager.isFileExistence('path/to/s3/file.txt')
  .then(exists => {
    console.log(`ファイルは存在${exists ? 'する' : 'しない'}`);
  })
  .catch(err => {
    console.error('ファイルの存在確認エラー:', err);
  });

ディレクトリのアップロード

s3Manager.putDirectoryToS3('path/to/local/directory', 'path/to/s3/directory')
  .then(() => {
    console.log('ディレクトリのアップロードに成功');
  })
  .catch(err => {
    console.error('ディレクトリのアップロードエラー:', err);
  });

config パラメータ

@mskii/s3-manager を使用する際に設定する config パラメータの一覧です。

パラメータ名	必須/オプショナル	説明	設定例
ACCESS_KEY_ID	必須	AWS アクセスキーID	あなたのAWSアクセスキーID
SECRET_ACCESS_KEY	必須	AWS シークレットアクセスキー	あなたのAWSシークレットアクセスキー
BUCKET_NAME	optional(default=null)	デフォルトの S3 バケット名。各メソッド引数での指定も可能	example-bucket
REGION_NAME	optional(default=ap-northeast-1)	AWS リージョン名	ap-northeast-1

設定例

以下は config.json を使った設定例です。

{
  "ACCESS_KEY_ID": "あなたのAWSアクセスキーID",
  "SECRET_ACCESS_KEY": "あなたのAWSシークレットアクセスキー",
  "BUCKET_NAME": "任意のバケット名",
  "REGION_NAME": "ap-northeast-1"
}

この設定ファイルは、S3Manager.create() メソッドで使用できます。

ライセンス

MIT

著者

mskii