Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dex4er/js-fs-gzip-blob-storage
Blob storage on filesystem, with gzip, streams and promises API
https://github.com/dex4er/js-fs-gzip-blob-storage
hacktoberfest
Last synced: about 2 months ago
JSON representation
Blob storage on filesystem, with gzip, streams and promises API
- Host: GitHub
- URL: https://github.com/dex4er/js-fs-gzip-blob-storage
- Owner: dex4er
- License: mit
- Created: 2018-05-12T18:48:34.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-23T17:34:26.000Z (2 months ago)
- Last Synced: 2024-10-24T01:28:43.159Z (2 months ago)
- Topics: hacktoberfest
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/fs-gzip-blob-storage
- Size: 101 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# fs-gzip-blob-storage
[](https://github.com/dex4er/js-fs-gzip-blob-storage)
[](https://github.com/dex4er/js-fs-gzip-blob-storage/actions/workflows/ci.yaml)
[](https://github.com/dex4er/js-fs-gzip-blob-storage/actions/workflows/trunk.yaml)
[](https://coveralls.io/github/dex4er/js-fs-gzip-blob-storage)
[](https://www.npmjs.com/package/fs-gzip-blob-storage)
Blob storage on a filesystem, with gzip, streams and promises API.
This is a wrapper for
[`fs-blob-storage`](https://www.npmjs.com/package/fs-blob-storage)
## Requirements
This module requires ES6 with Node >= 16.
## Installation
```shell
npm install fs-gzip-blob-storage
```
_Additionally for Typescript:_
```shell
npm install -D @types/node
```
## Usage
```js
import FsGzipBlobStorage from "fs-gzip-blob-storage"
```
### DEFAULT_EXT
The default `ext` option is `''`
### DEFAULT_GZIP_EXT
The default `gzipExt` option is `'.gz'`
### DEFAULT_PART
The default `part` option is `'.part'`
### constructor
```js
const storage = new FsGzipBlobStorage(options)
```
_Options:_
- `ext` is a default `ext` argument for methods (optional, default: `DEFAULT_EXT`)
- `part` is a default `part` argument for methods (optional, default:
`DEFAULT_PART`)
- `exclusive` if is true then can't create new object if already exists with
the same key (optional, default: false)
- `gzipExt` is an extra extension for gzipped files (optional, default: `DEFAULT_GZIP_EXT`)
- `gzipOptions` is an object with options for gzip/gunzip (optional)
- `path` is a directory path of the storage (optional, default: ".")
_Example:_
```js
const storage = new FsGzipBlobStorage({
path: "/usr/share/man",
exclusive: true,
})
```
### createWriteStream
```js
const writable = await storage.createWriteStream(key, options)
```
_Options:_
- `ext` is a default extension added to the file name for the object
(optional, default: `this.ext`)
- `part` is a extension added to the file name which can be later committed
(optional, default: `this.part`)
Creates a writable stream for a new object in the storage. The object is
gzipped and stored with the file name based on `key` and `ext` and `gzipExt`
and `part`. Throws an error if has occurred and if the file already exists
for exclusive mode.
### createReadStream
```js
const readable = await storage.createWriteStream(key, options)
```
_Options:_
- `ext` is a default extension added to the file name for the object
(optional, default: `this.ext`)
Creates a readable stream for an existing, gunzipped object in the storage.
Throws an error if has occurred or if the object doesn't exist or its size is
zero.
### commit
```js
await storage.commit(key, options)
```
_Options:_
- `ext` is a default extension added to the file name for the object
(optional, default: `this.ext`)
- `part` is a extension added to the file name which can be later committed
(optional, default: `this.part`)
Commits the object in the storage. It means that the file name for the object
is renamed and the additional extension for partial objects is removed.
Throws an error if has occurred or the object doesn't exist.
### remove
```js
await storage.remove(key, options)
```
_Options:_
- `ext` is a default extension added to the file name for the object
(optional, default: `this.ext`)
Removes the object from the storage. Throws an error if has occurred or the
object doesn't exist.
## License
Copyright (c) 2018-2024 Piotr Roszatycki
[MIT](https://opensource.org/licenses/MIT)