# @solid-rest/file

> solid-rest plugin for filesystems

Latest version **2.1.21** (published 2025-05-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install @solid-rest/file
pnpm add @solid-rest/file
yarn add @solid-rest/file
bun add @solid-rest/file
```

## Health

**Score 30/100 (F)** — status: maintenance-mode.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.21 |
| Published | 2025-05-15 |
| First published | 2020-12-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=16.0.0 |
| Dependencies | 6 |
| Unpacked size | 71.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 40 |
| Author | Jeff Zucker |
| Maintainers | jeff-zucker |
| Keywords | solid, linked data, file systems |

## Links

- npm: https://www.npmjs.com/package/@solid-rest/file
- Repository: https://github.com/solid/solid-rest
- Homepage: https://github.com/solid/solid-rest#readme
- Issues: https://github.com/solid/solid-rest/issues
- npm.io page: https://npm.io/package/@solid-rest/file

## Dependencies (6)

- [rdflib](https://npm.io/package/rdflib.md) ^2.2.37
- [stream](https://npm.io/package/stream.md) 0.0.2
- [fs-extra](https://npm.io/package/fs-extra.md) ^9.0.1
- [mime-types](https://npm.io/package/mime-types.md) ^2.1.27
- [concat-stream](https://npm.io/package/concat-stream.md) ^2.0.0
- [@solid-rest/core](https://npm.io/package/@solid-rest/core.md) ^2.1.19

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 2.1.21 (latest) — 2025-05-15
- 2.1.20 — 2024-03-17
- 2.1.19 — 2024-03-12
- 2.1.18 — 2024-02-26
- 2.1.17 — 2022-03-10
- 2.1.16 — 2022-03-10
- 2.1.15 — 2022-03-10
- 2.1.14 — 2022-03-10
- 2.1.13 — 2022-03-10
- 2.1.12 — 2022-03-09
- 2.1.11 — 2022-03-09
- 2.1.10 — 2022-03-09
- 2.1.9 — 2022-02-23
- 2.1.8 — 2022-02-22
- 2.1.7 — 2021-12-29
- … 29 more at https://npm.io/package/@solid-rest/file/versions

## README

# Solid-Rest-File

**Treat any file system as a serverless Solid pod**

This library treats a local file system as a serverless Solid Pod, accepting Solid requests (GET, PUT, etc.) and returning Solid responses (wac-allow headers, turtle representation of folders, etc.).

The library may be used stand-alone (see [tests](./tests/all.js) for examples), or as a plugin to [Solid-Node-Client](https://github.com/solid/solid-node-client) from where it can be integrated into almost any Solid library or app.  Simply import Solid-Node-Client and thereafter use file:// URLs almost anywhere that https:// URLs work.  See the Solid-Node-Client documentation for details.

© 2021, Jeff Zucker, may be freely used with an MIT license.

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