Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shimohq/awos-js
AWOS-JS: Wrapper For Aliyun OSS And Amazon S3
https://github.com/shimohq/awos-js
aws minio oss
Last synced: 10 days ago
JSON representation
AWOS-JS: Wrapper For Aliyun OSS And Amazon S3
- Host: GitHub
- URL: https://github.com/shimohq/awos-js
- Owner: shimohq
- Created: 2019-03-13T03:54:22.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-06T09:05:19.000Z (6 months ago)
- Last Synced: 2024-10-08T12:51:52.768Z (about 1 month ago)
- Topics: aws, minio, oss
- Language: TypeScript
- Homepage:
- Size: 408 KB
- Stars: 15
- Watchers: 6
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
AWOS-JS: Wrapper For Aliyun OSS And Amazon S3
====
awos for golang: https://github.com/shimohq/awos
## feat
- same usage and methods for aws & oss, pretty convenient!
- add retry strategy
- avoid 404 status code:
- `get(key: string, metaKeys?: string[]): Promise` will return null when object not exist
- `head(key: string): Promise | null>` will null when object not exist
## installing
```
npm i awos-js --save
```
## how to use
```javascript
// for typescript
import AWOS from 'awos-js'
// for js
const AWOS = require('awos-js')
```
### for Aliyun OSS
```javascript
const client = new AWOS.Client({
type: 'oss',
ossOptions: {
accessKeyId: 'accessKeyId',
accessKeySecret: 'accessKeySecret',
bucket: 'bucket',
endpoint: 'endpoint',
}
})
```
### for Amazon S3(minio)
```javascript
const client = new AWOS.Client({
type: 'aws',
awsOptions: {
accessKeyId: 'accessKeyId',
secretAccessKey: 'secretAccessKey',
bucket: 'bucket',
// when use minio, S3ForcePathStyle must be set true
// when use aws, endpoint is unnecessary and region must be set
region: "region",
endpoint: 'endpoint',
s3ForcePathStyle: true,
}
})
```
the available operation：
```javascript
get(key: string, metaKeys?: string[]): Promise;
getAsBuffer(key: string, metaKeys: string[]): Promise;
put(key: string, data: string | Buffer, options?: IPutObjectOptions): Promise;
del(key: string): Promise;
delMulti(keys: string[]): Promise; // return keys not deleted
head(key: string, options?: IHeadOptions): Promise | null>;
listObject(key: string, options?: IListObjectOptions): Promise;
listDetails(key: string, options?: IListObjectOptions): Promise;
signatureUrl(key: string, options?: ISignatureUrlOptions): Promise;
copy(key: string, source: string, options?: ICopyObjectOptions): Promise;
```
### Change Log
- v2.0.0 / 2020-06-18
- Breaking
- conbine parameters `meta`,`contentType`,`headers` of `AWOS.put` into `options`
- add `headers` option support for `put` method
- v1.0.4 / 2019-12-26
- support buffer in get and put operation
- v1.0.3 / 2019-03-28
- put() support contentType params
- v1.0.2 / 2019-03-26
- support signatureUrl() operation
- v1.0.1 / 2019-03-19
- bug fix: oss listObject() should return [] when options.prefix not exist in the bucket; oss listObject() maxKeys not working