https://github.com/akryum/reactive-fs
Reactive file system interface
https://github.com/akryum/reactive-fs
Last synced: over 1 year ago
JSON representation
Reactive file system interface
- Host: GitHub
- URL: https://github.com/akryum/reactive-fs
- Owner: Akryum
- Created: 2021-11-01T17:48:14.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-12-08T19:25:33.000Z (over 4 years ago)
- Last Synced: 2025-02-28T18:48:36.346Z (over 1 year ago)
- Language: TypeScript
- Size: 78.1 KB
- Stars: 38
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# reactive-fs
A reactive filesystem interface based on Vue 3 reactivity system.
```js
import { createReactiveFileSystem } from 'reactive-fs'
// Create a reactive filesystem
const fs = await createReactiveFileSystem({
baseDir: __dirname,
glob: ['**/*.js'],
ignored: ['excluded'],
})
// List files
fs.list()
fs.list('.', { excludeSubDirectories: true })
fs.list('sub')
// List is reactive
let results = []
fs.effect(() => {
// This will update `results` each time a file is added or removed
results = fs.list('.', { excludeSubDirectories: true }).sort()
})
// Create a file
fs.createFile('foo.js', '')
// Remove a file
fs.files['foo.js'].remove()
// Read a file
const content = await fs.files['meow.js'].waitForContent
// `content` is a reactive property
let result
fs.effect(() => {
result = fs.files['meow.js'].content
})
// Write to a file
fs.files['meow.js'].content = 'waf'
// Destroy the filesystem
await fs.destroy()
```