https://github.com/hyper63/hyper-adapter-fs
File system adapter for Hyper Storage port
https://github.com/hyper63/hyper-adapter-fs
Last synced: 7 months ago
JSON representation
File system adapter for Hyper Storage port
- Host: GitHub
- URL: https://github.com/hyper63/hyper-adapter-fs
- Owner: hyper63
- License: apache-2.0
- Created: 2021-06-17T16:45:18.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-11-28T23:24:29.000Z (over 2 years ago)
- Last Synced: 2025-06-04T00:06:16.880Z (10 months ago)
- Language: JavaScript
- Homepage:
- Size: 215 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
hyper-adapter-fs
A Storage port adapter that uses the local file system for object storage in the hyper service framework
---
## Table of Contents
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Features](#features)
- [Methods](#methods)
- [Contributing](#contributing)
- [License](#license)
## Getting Started
`hyper.config.js`
```js
import { default as fs } from 'https://x.nest.land/hyper-adapter-fs@2.0.3/mod.js'
export default {
app,
adapter: [{ port: 'storage', plugins: [fs({ dir: './data' })] }],
}
```
## Installation
This is a Deno module available to import from
[nest.land](https://nest.land/package/hyper-adapter-fs)
deps.js
```js
export { default as fs } from 'https://x.nest.land/hyper-adapter-fs@2.0.3/mod.js'
```
## Features
- Create an bucket as a directory
- Remove an bucket as a directory
- List buckets as directories
- Put an object into a bucket as a directory
- Remove an object from a bucket as a directory
- Get an object from a bucket as a directory
- List objects in a bucket as a directory
## Methods
This adapter fully implements the Storage port and can be used as the
[hyper Storage service](https://docs.hyper.io/storage-api) adapter
See the full port [here](https://nest.land/package/hyper-port-storage)
## Contributing
Contributions are welcome! See the hyper
[contribution guide](https://docs.hyper.io/contributing-to-hyper)
## Testing
```
deno task test
```
To lint, check formatting, and run unit tests
## License
Apache-2.0