https://github.com/riccox/oss-uploader-js

This a node package helps you to integrate multi-type object storage services into one line code.
https://github.com/riccox/oss-uploader-js

aws-s3 cos nodejs oss s3 tencent-cos tencentcloud uploader

Last synced: 3 months ago
JSON representation

This a node package helps you to integrate multi-type object storage services into one line code.

• Host: GitHub
• URL: https://github.com/riccox/oss-uploader-js
• Owner: riccox
• License: mit
• Created: 2022-08-31T11:12:23.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-18T14:43:47.000Z (over 2 years ago)
• Last Synced: 2025-01-12T07:43:08.476Z (4 months ago)
• Topics: aws-s3, cos, nodejs, oss, s3, tencent-cos, tencentcloud, uploader
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@lrvinye/oss-uploader
• Size: 141 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @lrvinye/oss-uploader

![Build Status](https://github.com/lrvinye/oss-uploader/actions/workflows/main.yml/badge.svg)

![publish-size](https://badgen.net/packagephobia/publish/@lrvinye/oss-uploader)

![publish-size](https://badgen.net/bundlephobia/minzip/@lrvinye/oss-uploader)

![release](https://badgen.net/github/release/lrvinye/oss-uploader)

![stars](https://badgen.net/github/stars/lrvinye/oss-uploader)

![package version](https://badgen.net/npm/v/@lrvinye/oss-uploader)

![downloads](https://badgen.net/npm/dt/@lrvinye/oss-uploader)

![node](https://badgen.net/npm/node/@lrvinye/oss-uploader)

![dependents](https://badgen.net/npm/dependents/@lrvinye/oss-uploader)

![license](https://badgen.net/npm/license/@lrvinye/oss-uploader)

![types](https://badgen.net/npm/types/@lrvinye/oss-uploader)

This a node package helps you to integrate multi-type object storage services into one line code.

### Usage

```

npm i @lrvinye/oss-uploader 

```

```ts

import { OSSProvider, Uploader, UploadResult } from '@lrvinye/oss-uploader';

const uploader = new Uploader({

  provider: OSSProvider.S3, // can be S3|COS

  endpoint: 's3.${region}.amazonaws.com',

  bucket: 'bucketName',

  credential: {

    secretId: '-',

    secretKey: '-',

  },

  prefix: '/images',

});

uploader

  .upload({body: fs.readFileSync("foo.jpg"), mime: "image/jpeg"})

  .then((res: UploadResult) => {

    console.log(res); // { uri: "images/VkbqGp6iKG3UbGgU.jpeg" }

  });

```

### Test

```

pnpm install 

```

```

pnpm test 

```