npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@hanzo/s3

v8.0.7

Published

Hanzo S3 - S3 Compatible Cloud Storage client

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

hanzo-iohanzo-iozeekayzeekayartemis-primeartemis-primezooqueenzooqueenjason_stujason_stuwbeanprowbeanpromusordmtmusordmtaputyaputyvenuswhispersvenuswhispers

Keywords

apiamazonhanzohanzo-s3clouds3storage

Readme

Hanzo S3 JavaScript SDK

CI NPM

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:

Bucket Operations

File Object Operations

Object Operations

Presigned Operations

Bucket Notification Operations

Bucket Policy Operations

Examples

Bucket Operations

File Object Operations

Object Operations

Presigned Operations

Bucket Notification Operations

Bucket Policy Operations

Custom Settings

Explore Further

Contribute

License

Apache 2.0