https://github.com/danieldietrich/async-memoize-file-store

Filesystem store for the async-memoize library
https://github.com/danieldietrich/async-memoize-file-store

Last synced: 19 days ago
JSON representation

Filesystem store for the async-memoize library

• Host: GitHub
• URL: https://github.com/danieldietrich/async-memoize-file-store
• Owner: danieldietrich
• License: mit
• Created: 2019-09-25T22:50:29.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T11:23:50.000Z (almost 2 years ago)
• Last Synced: 2024-10-13T15:45:28.032Z (about 1 month ago)
• Language: TypeScript
• Size: 595 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
[![npm version](https://img.shields.io/npm/v/@danieldietrich/async-memoize-file-store?logo=npm&style=flat-square)](https://www.npmjs.com/package/@danieldietrich/async-memoize-file-store/)[![vulnerabilities](https://img.shields.io/snyk/vulnerabilities/npm/@danieldietrich/async-memoize-file-store?style=flat-square)](https://snyk.io/test/npm/@danieldietrich/async-memoize-file-store)[![minzipped size](https://img.shields.io/bundlephobia/minzip/@danieldietrich/async-memoize-file-store?style=flat-square)](https://bundlephobia.com/result?p=@danieldietrich/async-memoize-file-store@latest)

 

[![build](https://img.shields.io/travis/danieldietrich/async-memoize-file-store?logo=github&style=flat-square)](https://travis-ci.org/danieldietrich/async-memoize-file-store/)[![coverage](https://img.shields.io/codecov/c/github/danieldietrich/async-memoize-file-store?style=flat-square)](https://codecov.io/gh/danieldietrich/async-memoize-file-store/)

 

![Platform](https://img.shields.io/badge/platform-Node%20v10%20%28ES6%2fES2015%29-decc47?logo=TypeScript&style=flat-square)

 

[![Sponsor](https://img.shields.io/badge/GitHub-💖Sponsors-b5b7b9?logo=github&style=flat-square)](https://github.com/sponsors/danieldietrich)[![donate](https://img.shields.io/badge/Donate-PayPal-blue.svg?style=flat-square)](https://paypal.me/danieldietrich13)[![license](https://img.shields.io/github/license/danieldietrich/async-memoize-file-store?style=flat-square)](https://opensource.org/licenses/MIT/)

 

[![Follow](https://img.shields.io/twitter/follow/danieldietrich?label=Follow&style=social)](https://twitter.com/danieldietrich/)

# async-memoize-file-store

Filesystem store for the [async-memoize](https://www.npmjs.com/package/@danieldietrich/async-memoize) module.

## Installation

```bash

npm i @danieldietrich/async-memoize-file-store

```

## Usage

The module supports ES6 _import_ and CommonJS _require_ style.

A file store is used in conjunction with the npm module [@danieldietrich/async-memoize](https://www.npmjs.com/package/@danieldietrich/async-memoize).

```ts

import memoize from '@danieldietrich/async-memoize';

import fileStore from '@danieldietrich/async-memoize-file-store';

```

A file store is bound to a specific directory. By default it is `path.join(process.cwd(), '.file-store'))`.

```ts

const storeFactory = fileStore();

```

Optionally, the store directory can be changed to a different location. Please note that the parent directory is required to already exist.

```ts

const storeFactory = fileStore('/tmp/.my-cache');

```

A file store is used in conjunction with function memoization. For each function that is memoized, we need a unique id. Valid id characters are `a-z A-Z 0-9 - . _ ~ ! $ & ' ( ) + , ; = @`. Invalid characters will be replaced with dash `-`. Please use only valid characters, otherwise it might lead to name collisions.

```ts

const store = storeFactory('my-module.my-function');

```

Once we created a file store instance, we can start to memoize function calls.

```ts

// example

function myFunction(a: number, b: string, c: boolean): string[] { return []; }

// typesafe, memoized version of myFunction

const mem = memoize(myFunction, store);

// result is written to the file store and returned

const res = mem(1, 'ok', true);

```

---

Copyright © 2020 by [Daniel Dietrich]([email protected]). Released under the [MIT](https://opensource.org/licenses/MIT/) license.