key-value-compress

Key-Value interface to deflate, split, concatenate and inflate storage.


Keywords
KVS, compress, deflate, key-value
License
MIT
Install
npm install key-value-compress@0.3.1

Documentation

key-value-compress

Node.js CI npm version

Key-Value interface to deflate, split, concatenate and inflate storage.

SYNOPSIS

const compressKVS = require("key-value-compress").compressKVS;
const axios = require("axios");
const Keyv = require("keyv");

const keyv = new Keyv();
const storage = compressKVS({storage: keyv});

async function ajaxGET(url) {
    const cache = await storage.get(url);
    if (cache) return cache;
    const {data} = await axios.get(url);
    if (data) await storage.set(url, data);
    return data;
}

const data = await ajaxGET("https://example.com/api.json");

See TypeScript declaration key-value-compress.d.ts for detail.

SEE ALSO

MIT LICENSE

Copyright (c) 2021-2022 Yusuke Kawasaki

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.