# cloudos-fs

**Repository Path**: peiiii/cloudos-fs

## Basic Information

- **Project Name**: cloudos-fs
- **Description**: Node-style file system API in browser.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-02-08
- **Last Updated**: 2023-03-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: file-system, browser, API, Nodejs

## README

<div id="top"></div>
<div align="center">
  <h3 align="center">npm install @cloudos/fs</h3>
  <p align="center">
    <b>Node-style file system API in browser.</b>
    <!-- <br/> -->
       <!-- <a href="README_CN.md">中文文档</a> -->
</p>
</div>

## About The Project
Node-style file system API in browser, using Local Storage, IndexedDB, Gitee repository, more backends can be extended.
          
### Built With
* typescript
* [browserfs](https://github.com/jvilk/BrowserFS)
* [lightning-fs](https://github.com/isomorphic-git/lightning-fs)
* [@cloudos/gitee-fs](https://gitee.com/peiiii/cloudos-gitee-fs)

## Getting Started
1. Install with `npm i @cloudos/fs` or `yarn add @cloudos/fs`.
2. Call the API just like in node;
```js
import {fs} from "@cloudos/fs";
fs.readdir("/",console.log);
```
### Use In Browser
```html
<script src="https://cdn.jsdelivr.net/npm/@cloudos/fs/dist/fs.iife.js"></script>
<script>
    var fs=FS.fs;
    fs.readdir("/",console.log);
</script>
```
## License
MIT License.

<p align="right">(<a href="#top">back to top</a>)</p>