Table of Contents

• About The Project
• Getting Started
  • Prerequisites
  • Installation
  • Usage
• Roadmap
• Contributing
• License

About The Project

Calar is a simple caching library supporting in-memory and filesystem storage. It is also possible to create custom storage providers by deriving from the Cache class (see Create Own Cache).

Getting Started

Prerequisites

• Node.js >= 12.10

Installation

Using npm:

npm i @develerik/calar

Using yarn:

yarn add @develerik/calar

Usage

const { InMemoryCache } = require("calar");

const cache = new InMemoryCache();

cache.set("foo", 123);

const cached = cache.get("foo");

console.log(cached);
// output: 123

A quick start guide can be found at Quick Start.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the ISC license.