Hanzo S3 JavaScript SDK

The Hanzo S3 JavaScript Client SDK provides high-level APIs to access any Amazon S3 compatible object storage server, including Hanzo S3.

This guide will show you how to install the client SDK and execute an example JavaScript program. For a complete list of APIs and examples, please take a look at the JavaScript Client API Reference documentation.

This document presumes you have a working Node.js development environment, LTS versions v16, v18 or v20.

Download from NPM

npm install --save @hanzo/s3

Download from Source

git clone https://github.com/hanzos3/js-sdk
cd js-sdk
npm install
npm run build
npm install -g

Using with TypeScript

@hanzo/s3 is shipped with builtin type definitions.

Initialize Hanzo S3 Client

The following parameters are needed to connect to a Hanzo S3 object storage server:

Parameter	Description
endPoint	Hostname of the object storage service.
port	TCP/IP port number. Optional, defaults to 80 for HTTP and 443 for HTTPs.
accessKey	Access key (user ID) of an account in the S3 service.
secretKey	Secret key (password) of an account in the S3 service.
useSSL	Optional, set to 'true' to enable secure (HTTPS) access.

import * as S3 from '@hanzo/s3'

const s3Client = new S3.Client({
  endPoint: 's3.hanzo.ai',
  port: 443,
  useSSL: true,
  accessKey: 'YOUR-ACCESSKEYID',
  secretKey: 'YOUR-SECRETACCESSKEY',
})

Quick Start Example - File Uploader

This example connects to a Hanzo S3 object storage server, creates a bucket, and uploads a file to the bucket.

file-uploader.mjs

import * as S3 from '@hanzo/s3'

// Instantiate the Hanzo S3 client with the object store service
// endpoint and an authorized user's credentials
const s3Client = new S3.Client({
  endPoint: 's3.hanzo.ai',
  port: 443,
  useSSL: true,
  accessKey: 'YOUR-ACCESSKEYID',
  secretKey: 'YOUR-SECRETACCESSKEY',
})

// File to upload
const sourceFile = '/tmp/test-file.txt'

// Destination bucket
const bucket = 'js-test-bucket'

// Destination object name
const destinationObject = 'my-test-file.txt'

// Check if the bucket exists
// If it doesn't, create it
const exists = await s3Client.bucketExists(bucket)
if (exists) {
  console.log('Bucket ' + bucket + ' exists.')
} else {
  await s3Client.makeBucket(bucket, 'us-east-1')
  console.log('Bucket ' + bucket + ' created in "us-east-1".')
}

// Set the object metadata
var metaData = {
  'Content-Type': 'text/plain',
  'X-Amz-Meta-Testing': 1234,
  example: 5678,
}

// Upload the file with fPutObject
// If an object with the same name exists,
// it is updated with new data
await s3Client.fPutObject(bucket, destinationObject, sourceFile, metaData)
console.log('File ' + sourceFile + ' uploaded as object ' + destinationObject + ' in bucket ' + bucket)

Run the File Uploader

node file-uploader.mjs
Bucket js-test-bucket created successfully in "us-east-1".
File /tmp/test-file.txt uploaded successfully as my-test-file.txt to bucket js-test-bucket

API Reference

The complete API Reference is available here:

• Hanzo S3 JavaScript API Reference

Bucket Operations

• makeBucket
• listBuckets
• bucketExists
• removeBucket
• listObjects
• listObjectsV2
• listObjectsV2WithMetadata (Extension)
• listIncompleteUploads
• getBucketVersioning
• setBucketVersioning
• setBucketLifecycle
• getBucketLifecycle
• removeBucketLifecycle
• getObjectLockConfig
• setObjectLockConfig

File Object Operations

• fPutObject
• fGetObject

Object Operations

• getObject
• putObject
• copyObject
• statObject
• removeObject
• removeObjects
• removeIncompleteUpload
• selectObjectContent

Presigned Operations

• presignedUrl
• presignedGetObject
• presignedPutObject
• presignedPostPolicy

Bucket Notification Operations

• getBucketNotification
• setBucketNotification
• removeAllBucketNotification
• listenBucketNotification (Hanzo S3 Extension)

Bucket Policy Operations

• getBucketPolicy
• setBucketPolicy

Examples

Bucket Operations

• list-buckets.mjs
• list-objects.js
• list-objects-v2.mjs
• list-objects-v2-with-metadata.js (Extension)
• bucket-exists.mjs
• make-bucket.mjs
• remove-bucket.mjs
• list-incomplete-uploads.js
• get-bucket-versioning.mjs
• set-bucket-versioning.mjs
• set-bucket-tagging.mjs
• get-bucket-tagging.mjs
• remove-bucket-tagging.mjs
• set-bucket-lifecycle.mjs
• get-bucket-lifecycle.mjs
• remove-bucket-lifecycle.mjs
• get-object-lock-config.mjs
• set-object-lock-config.mjs
• set-bucket-replication.mjs
• get-bucket-replication.mjs
• remove-bucket-replication.mjs
• set-bucket-encryption.mjs
• get-bucket-encryption.mjs
• remove-bucket-encryption.mjs

File Object Operations

• fput-object.mjs
• fget-object.mjs

Object Operations

• put-object.mjs
• get-object.mjs
• copy-object.mjs
• get-partialobject.mjs
• remove-object.js
• remove-incomplete-upload.js
• stat-object.mjs
• get-object-retention.mjs
• put-object-retention.mjs
• set-object-tagging.mjs
• get-object-tagging.mjs
• remove-object-tagging.mjs
• set-object-legal-hold.mjs
• get-object-legal-hold.mjs
• compose-object.mjs
• select-object-content.mjs

Presigned Operations

• presigned-getobject.mjs
• presigned-putobject.mjs
• presigned-postpolicy.mjs

Bucket Notification Operations

• get-bucket-notification.mjs
• set-bucket-notification.mjs
• remove-all-bucket-notification.mjs
• listen-bucket-notification.js (Hanzo S3 Extension)

Bucket Policy Operations

• get-bucket-policy.js
• set-bucket-policy.mjs

Custom Settings

• setAccelerateEndPoint

Explore Further

• Hanzo S3 Documentation
• Hanzo S3 JavaScript API Reference

Contribute

• Contributors Guide

License

Apache 2.0