https://github.com/yjl9903/breadfs
Unified File System Abstraction
https://github.com/yjl9903/breadfs
file-system node webdav
Last synced: about 1 year ago
JSON representation
Unified File System Abstraction
- Host: GitHub
- URL: https://github.com/yjl9903/breadfs
- Owner: yjl9903
- License: mit
- Created: 2023-09-10T17:34:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-13T20:49:50.000Z (about 1 year ago)
- Last Synced: 2025-03-13T21:37:07.654Z (about 1 year ago)
- Topics: file-system, node, webdav
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/breadfs
- Size: 1.28 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BreadFS
[](https://www.npmjs.com/package/breadfs)
[](https://github.com/yjl9903/breadfs/actions/workflows/ci.yml)
Unified File System Abstraction.
+ Frequently used **file system operation API**
+ **Operate files across different file systems**
+ [Node.js fs module](https://nodejs.org/api/fs.html) provider
+ [WebDAV client](https://github.com/perry-mitchell/webdav-client) provider
```ts
import { fs as nfs } from 'breadfs/node'
import { WebDAVFS } from 'breadfs/webdav'
// Write something to hello.txt
const local = nfs.path('hello.txt')
await local.writeText('This is used for testing')
// Create WebDAV file system
const wfs = WebDAVFS.make("https://some-server.org", {
username: "user",
password: "pass"
})
// Copy the local hello.txt to the remote WebDAV server
const remote = wfs.path('/hello.txt')
await local.copyTo(remote)
await remote.readText()
// Return 'This is used for testing'
```
## Installation
```bash
npm i breadfs
```
> **Notice**
>
> This package is built on the web native [Streams API](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API). You should add `"lib": ["ES2018", "DOM"]` to your `tsconfig.json`.
## Usage
### Node
```ts
import { fs as nfs } from 'breadfs/node'
const bin = nfs.path('/bin')
await bin.list()
await bin.join('node').stat()
await nfs.path('/home/.bashrc').readFile()
await nfs.path('/home/.bashrc').readText()
await nfs.path('/home/test.txt').writeText('This is used for testing')
```
### WebDAV
```bash
npm i breadfs @breadfs/webdav
```
```ts
import { WebDAVFS } from 'breadfs/webdav'
const wfs = WebDAVFS.make("https://some-server.org", {
username: "user",
password: "pass"
})
await wfs.path('/test.txt').readText()
```
### Across different file systems
```ts
import { fs as nfs } from 'breadfs/node'
import { WebDAVFS } from 'breadfs/webdav'
const wfs = WebDAVFS.make("https://some-server.org", {
username: "user",
password: "pass"
})
const local = nfs.path('hello.txt')
const remote = wfs.path('/hello.txt')
await local.writeText('This is used for testing')
await local.copyTo(remote)
await remote.readText() // 'This is used for testing'
```
Operating files across various different file systems can be quite **challenging**, which means our implementation may **not function perfectly in all scenarios**. Even file system in your local machine may encounter some bugs.
So that the goal of this package is to provide **a straightforward abstraction and utility** for use in **less complex or basic situations**.
## Related
This package is used to power [AnimeSpace](https://github.com/yjl9903/AnimeSpace), offering a comprehensive solution for automatically following bangumis. It can fetch anime resources, download desired video content, and upload them to the local file system or remote WebDAV server. The upload process is facilitated by this package.
## License
MIT License © 2023 [XLor](https://github.com/yjl9903)