Giter VIP home page Giter VIP logo

safe-file-cache's Introduction

safe-file-cache

Safely generate and consume cache files, better for cluster deployment.

Requirements

  • Node >= 14.14

Installation

# use npm
npm install -S safe-file-cache

# use yarn
yarn add safe-file-cache

# use pnpm
pnpm install safe-file-cache

Usage

Basic

const { SafeFileCache } = require('safe-file-cache');

const fileCache = new SafeFileCache({
  cacheDir: '.fileCache',
});

async function getFileBuffer(filename) {
  let buffer = await fileCache.loadBuffer(filename);
  if (!buffer) {
    const cachePath = await fileCache.save(filename, '123' /* some data... */);
    buffer = await fs.readFile(cachePath);
  }
  return buffer;
}

getFileBuffer('foo.txt');

Stream

const { SafeFileCache } = require('safe-file-cache');
const express = require('express');
const axios = require('axios');

const app = express();

const fileCache = new SafeFileCache();

app.get('/foo', async (req, res) => {
  let stream = await fileCache.loadStream(filename);
  if (!stream) {
    stream = fileCache
      .save(filename, async () => {
        // fetch stream example
        const { data } = await axios.get('https://example.com/bar.tgz', {
          responseType: 'stream'
        });
        return data;
      })
      .stream();
  }
  stream.pipe(res);
});

API

See type-definitions.

safe-file-cache's People

Contributors

peakchen90 avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.