# mini-ali-oss

**Repository Path**: zaoangod/mini-ali-oss

## Basic Information

- **Project Name**: mini-ali-oss
- **Description**: 轻量的阿里云 OSS 库 for browser
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-10-31
- **Last Updated**: 2025-06-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# mini-ali-oss

轻量的阿里云 OSS 库 for browser

精简阿里云 OSS API，去除不常用的接口精简体积，正在不断的补充常用API。

## 特征

- 无第三方依赖，更轻量
- 使用 `TypeScript` 编写

## 用法

### 安装

```shell
yarn add mini-ali-oss
```

### 创建配置实例

```typescript

// 创建一个配置实例
let oss;

// 直接使用key和密钥
oss = new TinyAliOss({
    key: 'LTAIOKxxxxxxWSue9q',
    secret: 'pyTLRH0sGooAxxxxxxxxxxxxxxxxxANqPedamD',
    bucket: 'bucket-name',
    region: 'oss-cn-shanghai'
});

// 使用STS
// ...
let stsResult = {...};
oss = new TinyAliOss({
    key: stsResult.key,
    secret: stsResult.secret,
    bucket: stsResult.bucket,
    region: stsResult.region,
    stsToken: stsResult.stsToken
});

// 选择文件
let fileData: FileData = await client.choose();

// 删除文件
await client.remove('user/avatar/002.png');

// 删除文件
await client.upload('user/avatar/002.png', Blob | ArrayBuffer);
```