fs-gzip-blob-storage

fs-gzip-blob-storage

Blob gzipped storage on filesystem with promises API.

This is a wrapper for fs-blob-storage

Requirements

This module requires ES6 with Node >= 6.

Installation

npm install fs-gzip-blob-storage

Additionally for Typescript:

npm install -D @types/node

Usage

const FsGzipBlobStorage = require('fs-gzip-blob-storage')

Typescript:

import FsGzipBlobStorage from 'fs-gzip-blob-storage'

constructor

const storage = new FsGzipBlobStorage(options)

Options:

• defaultExt is a default ext argument for methods (optional, default: "")
• defaultPart is a default part argument for methods (optional, 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: ".gz")
• gzipOptions is an object with options for gzip/gunzip (optional)
• path is a directory path of the storage (optional, default: ".")

Example:

const storage = new FsGzipBlobStorage({
  path: '/usr/share/man',
  exclusive: true
})

createWriteStream

const writable = await storage.createWriteStream(key, options)

Options:

• ext is a default extension added to file name for the object (optional, default: this.defaultExt)
• part is a extension added to file name which can be later commited (optional, default: this.defaultPart)

Creates a writable stream for a new object in the storage. 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

const readable = await storage.createWriteStream(key, options)

Options:

• ext is a default extension added to file name for the object (optional, default: this.defaultExt)

Creates a readable stream for an existing, gunzipped object in the storage. Throws an error if has occurred or the object doesn't exist or its size is zero.

commit

await storage.commit(key, options)

Options:

• ext is a default extension added to file name for the object (optional, default: this.defaultExt)
• part is a extension added to file name which can be later commited (optional, default: this.defaultPart)

Commits the object in the storage. It means that 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

await storage.remove(key, options)

Options:

• ext is a default extension added to file name for the object (optional, default: this.defaultExt)

Removes the object from the storage. Throws an error if has occurred or the object doesn't exist.

License

Copyright (c) 2018 Piotr Roszatycki [e-mail]

MIT

Changelog

v0.4.0 2018-07-16

• New option fs with File System module.
• Tests don't use mock-fs package anymore.
• Tweaked jsdoc.
• Pack only important files.