https://github.com/paul-go/airs3
Lightweight S3 HTTP Client For Browsers
https://github.com/paul-go/airs3
Last synced: 3 months ago
JSON representation
Lightweight S3 HTTP Client For Browsers
- Host: GitHub
- URL: https://github.com/paul-go/airs3
- Owner: paul-go
- Created: 2021-05-15T17:39:52.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-08-07T22:01:43.000Z (almost 4 years ago)
- Last Synced: 2024-04-26T10:42:32.523Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 84 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# AirS3
AirS3 is a lightweight S3 HTTP client for browsers. It's designed to feel as egonomic as other HTTP clients such as [ky](https://github.com/sindresorhus/ky), except that the request signing process happens automatically in the background.
## What This Solves
Amazon claims that [S3 has a REST API](https://docs.aws.amazon.com/AmazonS3/latest/API/API_Operations_Amazon_Simple_Storage_Service.html). While this is technically true, the request signing process is so convoluted that practically speaking, you can't actually use it like a normal REST API. You need to access it via the Amazon SDK which is a JavaScript dependency that weighs in at about 15 ZB. Ok, so that's a bit of an exaggeration. But it's certainly not small.
The purpose of this library is to enable ergonomic access to the S3 REST API, and let the signing process take care of itself. This is handy when dealing with other S3-compatible services like [Airbox](https://www.airbox.ai) and [Cloudian](https://www.cloudian.com) that have proprietary features in their S3-compatible APIs.
This library is certainly more low-level than using the AWS SDK directly. You'll probably need to keep the [AWS S3 API documentation](https://docs.aws.amazon.com/AmazonS3/latest/API/API_Operations_Amazon_Simple_Storage_Service.html) open while using it. But there are efficiency wins by going this route.
## Features
- Lightweight, only 3.7kb (GZipped + Minified)
- No dependencies
- Written in TypeScript (compiles with all strict options enabled)
- Code is well commented, optimized for readability, debuggability, and IntelliSense.
- Promise-based, fetch-style API, but uses XMLHttpRequest in order to support upload progress events.
- Distributes as a single JavaScript file.
- Uses the browser's DOMParser class to efficiently convert JSON POST/PUT bodies into XML.
## Installation
With npm:
```
npm install airs3
```
Include directly from jsDelivr:
```
```
## Code Examples
Coming soon.
## Funding
The development of this library is funded by [Airbox](https://www.airbox.app). This library is being used by Airbox's upcoming browser-based S3 file manager (which may also be open-sourced at some point). If you'd like to support this project, consider moving off of Amazon S3 and giving [Airbox](https://www.airbox.app) a try.