# ylzcc-sdk-filemanager

> 文件管理工具，集成七牛云kodo、阿里云oss

Latest version **1.0.0** (published 2023-02-12) · ISC license · 0 weekly downloads

## Install

```sh
npm install ylzcc-sdk-filemanager
pnpm add ylzcc-sdk-filemanager
yarn add ylzcc-sdk-filemanager
bun add ylzcc-sdk-filemanager
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-02-12 |
| First published | 2023-02-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 16.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | zyjing |
| Keywords | filemanager, kodo, oss, 文件上传, 对象存储 |

## Links

- npm: https://www.npmjs.com/package/ylzcc-sdk-filemanager
- npm.io page: https://npm.io/package/ylzcc-sdk-filemanager

## Dependencies (2)

- [node](https://npm.io/package/node.md) ^19.6.0
- [qiniu](https://npm.io/package/qiniu.md) ^7.8.0

## Recent versions

- 1.0.0 (latest) — 2023-02-12

## README

# filemanager typescript版
***

## 简介
此版本基于typescript语言开发，集成七牛云kodo、阿里云oss对象存储服务sdk按照适配器设计模式进行封装，减少开发者调用七牛云kodo/阿里云oss sdk的编码工作；统一命名接口方法名称，可减少未来若需更换不同对象存储服务带来的重复劳动。

1.0.0版仅集成七牛云kodo。

## 支持
- 文件上传
- 授权访问
- 文件删除
- 文件重命名
- 文件是否存在

## 示例
```javascript
import { Readable, Stream } from "node:stream"
import FileManager from "../src/FileManager"
import { manager as cate, prop, ReadResponse, WriteResponse } from "../src/type"
import qiniu = require('qiniu')
import assert = require("assert")
import { it } from "node:test"

let config: prop = {
    manager: cate.kodo,
    key: '***',
    secret: '***',
    bucket: '***',
    domainOfBucket: '***,'
    region: '***'
    expireInSeconds: 3600
}

let manager = new FileManager(config)
let filename = "hello.txt"

it("write", async () => {
    let stream = Readable.from(Buffer.from('12345', 'utf-8'))
    let res: WriteResponse = await manager.write(stream, filename)
    assert.ok(res)
})

it("read", async () => {
    let res: ReadResponse = await manager.read(filename)
    assert.ok(res)
})

```

## 更新
- 2023/02/10 v0.1

## 应用
- 非税票据查验

---
_Source: https://npm.io/package/ylzcc-sdk-filemanager · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._