# @cuberqaq/fs-side

> Simple Lib for ZeppOS 1.0/2.0/2.1 app-side to build a vitual file system.

Latest version **1.0.5** (published 2023-10-20) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @cuberqaq/fs-side
pnpm add @cuberqaq/fs-side
yarn add @cuberqaq/fs-side
bun add @cuberqaq/fs-side
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2023-10-20 |
| First published | 2023-10-18 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 47.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | CuberQAQ |
| Maintainers | cuberqaq |
| Keywords | zeppos, zepp |

## Links

- npm: https://www.npmjs.com/package/@cuberqaq/fs-side
- Repository: https://github.com/CuberQAQ/zepp-fs-side
- Homepage: https://github.com/CuberQAQ/zepp-fs-side#readme
- Issues: https://github.com/CuberQAQ/zepp-fs-side/issues
- npm.io page: https://npm.io/package/@cuberqaq/fs-side

## Dependencies (1)

- [@cuberqaq/path-polyfill](https://npm.io/package/@cuberqaq/path-polyfill.md) ^1.0.0

## Recent versions

- 1.0.5 (latest) — 2023-10-20
- 1.0.4 — 2023-10-20
- 1.0.3 — 2023-10-18
- 1.0.2 — 2023-10-18
- 1.0.1 — 2023-10-18
- 1.0.0 — 2023-10-18

## README

# fs-side

Simple Lib for ZeppOS 1.0/2.0/2.1 app-side to build a vitual file system.

It use settings storage api to storage data, not a true file system, so don't save many big files. Welcome to send issues and PR to make this project better!
Some api were not tested. I don't know whether it could work correctly.

## 1. Install

Use Command `npm i @cuberqaq/fs-side --save` to install fs-side in your ZeppOS Miniapp project.

## 2. Import & Use

In your app-side JavaScript source file, use this to import fs-side:

```js
import * as fs from "@cuberqaq/fs-side";
```

Then you can use the methods in the same way you do with @zos/fs module. API Document see [Zepp OS Developers Documentation](https://docs.zepp.com/docs/reference/device-app-api/newAPI/fs/closeSync/)
For example:

```js
import fs from "@cuberqaq/fs-side";
fs.writeFileSync({
  path: "test.txt",
  data: "hello world!",
  options: {
    encoding: "utf8",
  },
});
```

---
_Source: https://npm.io/package/@cuberqaq/fs-side · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._