@emech/memoization

Memoization

A general introduction into memoization: https://en.wikipedia.org/wiki/Memoization

Memoization is a simple npm package to cache the result of the provided function for a limited amount of time.

The purpose of this project is to demonstrate the followings:

• Development of a simple npm package with javascript.
• Automatic Unit Tests and achieving 100% coverage.
• Using CI/CD tools:
  • Github Actions to automatically run tests and publish the npm package.
• Using Automatic Versioning:
  • Use Semantic Release to calculate new version number by processing commit messages.
  • Publish the next branch to the next channel on npm and publish the master branch to the main channel.

Instalation

yarn add @emech/memoization

Usage

const memoize = require("@emech/memoization").memoize;

const random = (max) => Math.random() * max;
const memoizedRandom = memoize(random, (max) => max, 1000);

const randomNumber = memoizedRandom(2);
const randomNumber2 = memoizedRandom(2);

assert(randomNumber === randomNumber2);

Api

memoize(realFunc [, resolver], timout) => memoizedFunc

• realFunc: function The function for which the return values should be cached.
• resolver: function (Optional) If provided gets called for each function call with the exact same set of parameters as the original function, the resolver function should provide the memoization key.
• timeout: number Timeout for cached values in milliseconds

Contribution

# Clone
$ git clone [e-mail]:emech-en/memoization.git

# Run test 
$ yarn test

# Report coverage
$ yarn test:coverage

Stay in touch

• Author: Emech En < [e-mail] >