snipe/web/node_modules/@quansync/fs/README.md
pyr0ball 7a704441a6 feat(snipe): Vue 3 frontend scaffold + Docker web service
- web/: Vue 3 + Vite + UnoCSS + Pinia, dark tactical theme (amber/#0d1117)
- AppNav, ListingCard, SearchView with filters/sort, composables
  (useSnipeMode, useKonamiCode, useMotion), Pinia search store
- Steal shimmer, auction countdown, Snipe Mode easter egg all native in Vue
- docker/web/: nginx + multi-stage Dockerfile (node build → nginx serve)
- compose.yml: api (8510) + web (8509) services
- Dockerfile CMD updated to uvicorn for upcoming FastAPI layer
- Clean build: 0 TS errors, 380 modules
2026-03-25 15:11:35 -07:00

50 lines
1.4 KiB
Markdown

# @quansync/fs
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Unit Test][unit-test-src]][unit-test-href]
Filesystem utilities for [quansync](https://github.com/quansync-dev/quansync).
## Install
```bash
npm i @quansync/fs
```
## Usage
```ts
import { readFile } from '@quansync/fs'
import { quansync } from 'quansync'
const resultAsync = await readFile('/path', 'utf8')
const resultSync = readFile.sync('/path', 'utf8')
const readFileTrimmed = quansync(function* (id: string) {
const text = yield* readFile(id, 'utf8').trim()
return text
})
const readFileTrimmedSync = readFileTrimmed.sync
```
## Sponsors
<p align="center">
<a href="https://cdn.jsdelivr.net/gh/sxzz/sponsors/sponsors.svg">
<img src='https://cdn.jsdelivr.net/gh/sxzz/sponsors/sponsors.svg'/>
</a>
</p>
## License
[MIT](./LICENSE) License © 2025-PRESENT [Kevin Deng](https://github.com/sxzz)
<!-- Badges -->
[npm-version-src]: https://img.shields.io/npm/v/@quansync/fs.svg
[npm-version-href]: https://npmjs.com/package/@quansync/fs
[npm-downloads-src]: https://img.shields.io/npm/dm/@quansync/fs
[npm-downloads-href]: https://www.npmcharts.com/compare/@quansync/fs?interval=30
[unit-test-src]: https://github.com/quansync-dev/fs/actions/workflows/unit-test.yml/badge.svg
[unit-test-href]: https://github.com/quansync-dev/fs/actions/workflows/unit-test.yml