Git Product home page Git Product logo

file-cache's Introduction

@file-cache

Transform Cache for JavaScript.

When to update the cache

  • When the source code changes.
  • When the dependencies change.
  • When the configuration changes.
  • When the cache is cleared.

Cache Mechanism

  • When A cache key is updated, all file cache should be updated
  • Cache file structure
|- .<cache-dorectory>
  |- <hash-of-cache-key>
{
  "file-path": <result>
}

Usage

import { creatCache, createCacheKey } from "@file-cache/core";
import { cacheKeyPackageJson, cacheKeyDependency } from "@file-cache/npm"

const config = {
    /*...*/
}
const cache = createCache({
    mode: "content",
    cacheDirectory: ".cache/my-tool", // node_modules/.cache/myTool by default 
    // create key for cache
    key: createCacheKey([
        // use dependency(version) as cache key
        cacheKeyDependencies(["prettier"]),
        // use custom key
        () => {
            return JSON.stringify(config);
        }
    ])
});

const result = await cache.get("file.js");
if (result) {
    return result
}
const transformed = await transform("file.js");
await cache.set("file.js", transformed);

file-cache's People

Contributors

azu 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.