Package Exports

@keyvhq/compress

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@keyvhq/compress) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@keyvhq/compress

Adds compression bindings for your Keyv instance.

Install

$ npm install @keyvhq/compress --save

Usage

All you need to do is to wrap your keyv instance:

const KeyvRedis = require('@keyvhq/redis')

const keyv = new KeyvRedis({
  uri: 'redis://user:pass@localhost:6379',
  maxRetriesPerRequest: 1,
  emitErrors: false
})

Using @keyvhq/compress at the top level:

const KeyvCompress = require('@keyvhq/compress')
const KeyvRedis = require('@keyvhq/redis')

const keyv = KeyvCompress(new KeyvRedis({
  uri: 'redis://user:pass@localhost:6379',
  maxRetriesPerRequest: 1,
  emitErrors: false
}))

Additionally, it can accept compress-brotli#options as second argument:

const keyv = KeyvCompress(new KeyvRedis({
  uri: 'redis://user:pass@localhost:6379',
  maxRetriesPerRequest: 1,
  emitErrors: false
}), {
  serialize: v8.serialize,
  deserialize: v8.deserialize
})

License

microlink.io · GitHub @MicrolinkHQ · Twitter @microlinkhq