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<IGetObjectResponse | null> will return null when object not exist
  • head(key: string): Promise<Map<string, string> | null> will null when object not exist

installing

npm i awos-js --save

how to use

1// for typescript
2import AWOS from 'awos-js';
3
4// for js
5const AWOS = require('awos-js');

for Aliyun OSS

1const client = new AWOS.Client({
2  type: 'oss',
3  ossOptions: {
4    accessKeyId: 'accessKeyId',
5    accessKeySecret: 'accessKeySecret',
6    bucket: 'bucket',
7    endpoint: 'endpoint'
8  }
9});

for Amazon S3(minio)

1const client = new AWOS.Client({
2  type: 'aws',
3  awsOptions: {
4    accessKeyId: 'accessKeyId',
5    secretAccessKey: 'secretAccessKey',
6    bucket: 'bucket',
7    // when use minio, S3ForcePathStyle must be set true
8    // when use aws, endpoint is unnecessary and region must be set
9    region: 'region',
10    endpoint: 'endpoint',
11    s3ForcePathStyle: true
12  }
13});

the available operation：

1get(key: string, metaKeys?: string[]): Promise<IGetObjectResponse | null>;
2getAsBuffer(key: string, metaKeys: string[]): Promise<IGetBufferedObjectResponse | null>;
3put(key: string, data: string | Buffer, options?: IPutObjectOptions): Promise<void>;
4del(key: string): Promise<void>;
5delMulti(keys: string[]): Promise<string[]>; // return keys not deleted
6head(key: string): Promise<Map<string, string> | null>;
7listObject(key: string, options?: IListObjectOptions): Promise<string[]>;
8listDetails(key: string, options?: IListObjectOptions): Promise<IListObjectOutput>;
9signatureUrl(key: string, options?: ISignatureUrlOptions): Promise<string | null>;
10copy(key: string, source: string, options?: ICopyObjectOptions): Promise<void>;

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